.. annular documentation master file, created by
   sphinx-quickstart on Wed May  5 22:45:36 2021.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to annular's documentation!
==========================================================

Annular is a framework for running coupled energy system models with the aim of
modeling flexibility scheduling and the policy regulations that affect the
behavior of flexibility providers.

Name
----
**Why the name 'annular'?**

'Annular' means 'in the shape of a ring', with which we specifically think of
the `rings of Saturn`_, containing many moons or in other words satellites, just
like the satellite models interacting with the central market model.

Annular was developed as part of the `DEMOSES`_ project,
funded by NWO under Grant ID: ESI.2019.004.

Last updated: (|today|)

.. toctree::
  :maxdepth: 1
  :caption: Contents:

  install
  example-usage
  basic-project
  coupled-simulation
  bidding-strategies/index
  tariffs
  developer

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

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

.. _DEMOSES: https://www.nwo.nl/en/projects/esi2019004
.. _rings of Saturn: https://en.wikipedia.org/wiki/Rings_of_Saturn