Skip to content

Latest commit

 

History

History
124 lines (87 loc) · 2.45 KB

index.rst

File metadata and controls

124 lines (87 loc) · 2.45 KB

Welcome to the FlexMeasures documentation!

In a world with renewable energy, flexibility is crucial and valuable. Planning ahead allows flexible assets to serve the whole system with their flexibility, e.g. by shifting or curtailing energy use. This can also be profitable for their owners.

The FlexMeasures Platform is a tool for scheduling flexible actions for energy assets. For this purpose, it performs three services:

  • Monitoring of incoming measurements
  • Forecasting of expected measurements
  • Scheduling flexible actions with custom optimization

For more on FlexMeasures services, read :ref:`services`. Or head right over to :ref:`getting_started`.

Using FlexMeasures benefits operators as well as asset owners, by allowing or automation, insight, autonomy and profit sharing. For more on benefits, consult :ref:`benefits`.

FlexMeasures is compliant with the Universal Smart Energy Framework (USEF). Therefore, this documentation uses USEF terminology, e.g. for role definitions. The intended users of FlexMeasures are a Supplier (energy company) and its Prosumers (asset owners who have energy contracts with that Supplier). The platform operator of FlexMeasures can be an Aggregator.

.. toctree::
    :caption: Purpose
    :maxdepth: 1
    services
    benefits

.. toctree::
   :maxdepth: 1
   :hidden:

   getting-started
   configuration
   changelog

.. toctree::
    :caption: The in-built UI
    :maxdepth: 1

    views/dashboard
    views/portfolio
    views/analytics
    views/admin


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

    tut/supplier
    tut/prosumer
    tut/aggregator
    tut/esco


.. toctree::
    :caption: The API
    :maxdepth: 1

    api/introduction
    api/simulation
    api/v2_0
    api/v1_3
    api/v1_2
    api/v1_1
    api/v1
    api/change_log

.. toctree::
    :caption: The CLI
    :maxdepth: 1

    cli/commands
    cli/change_log


.. toctree::
    :caption: Developers
    :maxdepth: 1

    dev/introduction
    dev/data
    dev/api
    dev/ci


.. toctree::
    :caption: Integrations
    :maxdepth: 2

    int/introduction


.. toctree::
    :caption: Narrative contents
    :maxdepth: 2

    qa/users
    qa/assets
    qa/markets
    qa/algorithms
    qa/data


Code documentation

Go To :ref:`source`.