modes.rst 1.2 KB

1234567891011121314151617181920212223242526
  1. .. _modes-dev:
  2. Modes
  3. ============
  4. FlexMeasures can be run in specific modes (see the :ref:`modes-config` config setting).
  5. This is useful for certain special situations. Two are supported out of the box and we document here
  6. how FlexMeasures behaves differently in these modes.
  7. Demo
  8. -------
  9. In this mode, the server is assumed to be used as a demonstration tool. The following adaptations therefore happen in the UI:
  10. - [UI] Logged-in users can view queues on the demo server (usually only admins can do that)
  11. - [UI] Demo servers often display login credentials, so visitors can try out functionality. Use the :ref:`demo-credentials-config` config setting to do this.
  12. Play
  13. ------
  14. In this mode, the server is assumed to be used to run simulations.
  15. - [API] The ``restoreData`` endpoint is registered, enabling database resets through the API.
  16. - [UI] On the asset page, the ``sensors_to_show`` attribute can be used to show any sensor from any account, rather than only sensors from assets owned by the user's organization.
  17. .. note:: A former feature of play mode is now a separate config setting. To allow overwriting existing data when saving data to the database, use :ref:`overwrite-config`.