.. SPDX-FileCopyrightText: 2025 Koen van Greevenbroek
..
.. SPDX-License-Identifier: CC-BY-4.0

API Reference
=============

This section provides automatically generated documentation for the workflow scripts and utility modules.

Core Scripts
------------

Model Building and Solving
~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. automodule:: workflow.scripts.build_model
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: workflow.scripts.solve_model
   :members:
   :undoc-members:
   :show-inheritance:

Data Preparation
~~~~~~~~~~~~~~~~

.. automodule:: workflow.scripts.prepare_population
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: workflow.scripts.prepare_health_costs
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: workflow.scripts.build_regions
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: workflow.scripts.simplify_gadm
   :members:
   :undoc-members:
   :show-inheritance:

Yield and Land Processing
~~~~~~~~~~~~~~~~~~~~~~~~~~

.. automodule:: workflow.scripts.compute_resource_classes
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: workflow.scripts.aggregate_class_areas
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: workflow.scripts.build_crop_yields
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: workflow.scripts.build_grassland_yields
   :members:
   :undoc-members:
   :show-inheritance:

Water Resources
~~~~~~~~~~~~~~~

.. automodule:: workflow.scripts.process_blue_water_availability
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: workflow.scripts.build_region_water_availability
   :members:
   :undoc-members:
   :show-inheritance:

Utility Modules
---------------

.. automodule:: workflow.scripts.raster_utils
   :members:
   :undoc-members:
   :show-inheritance:

Visualization Scripts
---------------------

.. automodule:: workflow.scripts.plotting.plot_results
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: workflow.scripts.plotting.plot_regions_map
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: workflow.scripts.plotting.plot_resource_classes_map
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: workflow.scripts.plotting.plot_crop_production_map
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: workflow.scripts.plotting.plot_health_impacts
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: workflow.scripts.plotting.plot_food_consumption
   :members:
   :undoc-members:
   :show-inheritance: