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

GreenBubble Documentation
==========================

.. image:: front_image.png
   :alt: GreenBubble network diagram
   :width: 100%
   :align: center

GreenBubble is built on `PyPSA <https://docs.pypsa.org/latest/>`_ —
an open-source toolbox for simulating and optimising modern power and
multi-energy systems.

.. toctree::
   :maxdepth: 1
   :caption: Getting Started

   introduction
   installation
   guide_snakemake

.. toctree::
   :maxdepth: 1
   :caption: Model Description

   network_model
   technologies
   economics
   methods

.. toctree::
   :maxdepth: 1
   :caption: Configuration Reference

   configuration
   wildcards

.. toctree::
   :maxdepth: 1
   :caption: Tutorials

   tutorial_1_greenfield
   tutorial_2_brownfield
   tutorial_2b_brownfield_heat
   tutorial_3_rolling_horizon
   tutorial_4_stochastic

.. toctree::
   :maxdepth: 1
   :caption: How-to Guides

   guide_demands
   guide_stochastic
   guide_temporal_resolution
   guide_rolling_horizon
   guide_outputs
   guide_economic_analysis
   examples

.. toctree::
   :maxdepth: 1
   :caption: Developer Reference

   workflow
   guide_new_technology
   implementation

.. toctree::
   :maxdepth: 1
   :caption: API Reference

   api

.. toctree::
   :maxdepth: 1
   :caption: References

   references