===============================
Welcome to eGo's documentation!
===============================


.. image:: images/open_ego_logo.png
   :scale: 40%
   :align: center
   :alt: eGo logo


eGo is an open-source Python tool for the cross-grid-level analysis
and optimization of flexibility deployment and grid expansion in
sector-coupled energy systems. It connects eTraGo and eDisGo in a
top-down workflow to analyse interactions between flexibility dispatch,
generation and storage operation, and grid expansion requirements across
all voltage levels.


Getting started
===============

.. toctree::
   :maxdepth: 2

   installation
   getting_started


About and methodology
=====================

.. toctree::
   :maxdepth: 2

   welcome
   theoretical_background


Development and reference
=========================

.. toctree::
   :maxdepth: 2

   developer
   whatsnew
   api


Related documentation
=====================

eGo builds on the functionalities of eTraGo and eDisGo. Detailed
information on the individual tools is available in their respective
documentation:

* `eTraGo documentation <https://etrago.readthedocs.io/>`_
* `eDisGo documentation <https://edisgo.readthedocs.io/>`_


Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`


.. raw:: html
   :file: _static/ribbons.html