.. SPDX-FileCopyrightText: Contributors to GreenBubble
.. SPDX-License-Identifier: CC-BY-4.0

.. _api:

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

This page documents the public functions and constants in each GreenBubble
script.  Docstrings are rendered automatically from the source code using
`Sphinx autodoc <https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html>`_.

Configuration & Parameters
---------------------------

.. automodule:: scripts.config
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: scripts.parameters
   :members:
   :undoc-members:
   :show-inheritance:

Data Retrieval
--------------

.. automodule:: scripts.retrieve
   :members:
   :undoc-members:
   :show-inheritance:

Preprocessing
-------------

.. automodule:: scripts.preprocessing
   :members:
   :undoc-members:
   :show-inheritance:

Helper Utilities
----------------

.. automodule:: scripts.helpers
   :members:
   :undoc-members:
   :show-inheritance:

Network Construction
--------------------

.. automodule:: scripts.prepare_network
   :members:
   :undoc-members:
   :show-inheritance:

Technology Inputs
-----------------

.. automodule:: scripts.technology_inputs
   :members:
   :undoc-members:
   :show-inheritance:

Stochastic Scenarios
---------------------

.. automodule:: scripts.create_stoch_scenarios
   :members:
   :undoc-members:
   :show-inheritance:

Snakemake Wrappers
------------------

.. automodule:: scripts.snakemake_retrieve_tech
   :members:

.. automodule:: scripts.snakemake_preprocess
   :members:

.. automodule:: scripts.snakemake_prepare_costs
   :members:

.. automodule:: scripts.snakemake_prepare_inputs
   :members:

.. automodule:: scripts.snakemake_build_network
   :members:

.. automodule:: scripts.snakemake_solve
   :members:

.. automodule:: scripts.snakemake_plot
   :members: