Flexmeasures

============================

.. note:: Read more on these features on `the FlexMeasures blog <https://flexmeasures.io/021-service-better-status-and-audit/>`_.

.. warning:: Upgrading to this version requires running ``flexmeasures db upgrade`` (you can create a backup first with ``flexmeasures db-ops dump``).

New features
-------------

* Add `asset/<id>/status` page to view asset statuses [see `PR 41 <https://github.com/FlexMeasures/flexmeasures/pull/941/>`_ and `PR #1035 <https://github.com/FlexMeasures/flexmeasures/pull/1035/>`_]
* Add `account/<id>/auditlog` and `user/<id>/auditlog` to view user and account related actions [see `PR 1042 <https://github.com/FlexMeasures/flexmeasures/pull/1042>`_]
* Support `start_date` and `end_date` query parameters for the asset page [see `PR 1030 <https://github.com/FlexMeasures/flexmeasures/pull/1030/>`_]
* In plots, add the asset name to the title of the tooltip to improve the identification of the lines [see `PR 1054 <https://github.com/FlexMeasures/flexmeasures/pull/1054/>`_]
* On asset page, show sensor IDs in sensor table [see `PR 1053 <https://github.com/FlexMeasures/flexmeasures/pull/1053/>`_]

Bugfixes
-----------

* Prevent the time window in the UI from moving to the latest data when refreshing the asset page [see `PR 1046 <https://github.com/FlexMeasures/flexmeasures/pull/1046>`_ and `PR #1056 <https://github.com/FlexMeasures/flexmeasures/pull/1056>`_]

Infrastructure / Support
----------------------

* Include started, deferred and scheduled jobs in the overview printed by the CLI command ``flexmeasures jobs show-queues`` [see `PR 1036 <https://github.com/FlexMeasures/flexmeasures/pull/1036/>`_]
* Make it as convenient to clear deferred or scheduled jobs from a queue as it was to clear failed jobs from a queue [see `PR 1037 <https://github.com/FlexMeasures/flexmeasures/pull/1037/>`_]

============================

Bugfixes
-----------

* Prevent **p**lay/**p**ause/**s**top of replays when editing a text field in the UI [see `PR 1024 <https://github.com/FlexMeasures/flexmeasures/pull/1024>`_]
* Skip unit conversion of :abbr:`SoC (state of charge)` related fields that are defined as sensors in a ``flex-model`` (specifically, ``soc-maxima``, ``soc-minima`` and ``soc-targets`` [see `PR 1047 <https://github.com/FlexMeasures/flexmeasures/pull/1047>`_]

============================

.. note:: Read more on these features on `the FlexMeasures blog <https://flexmeasures.io/020-faster-data-reads/>`__.

.. warning:: From this version on, the config setting `FLEXMEASURES_FORCE_HTTPS` decides whether to enforce HTTPS on requests - and it defaults to `False`. Previously, this was governed by `Flask_ENV` or `FLEXMEASURES_ENV` being set to something else than "documentation" or "development". This new way is more clear, but you might be in need of using this setting before upgrading.

New features
-------------

* Add command ``flexmeasures edit transfer-ownership`` to transfer the ownership of an asset and its children from one account to another[see `PR 983 <https://github.com/FlexMeasures/flexmeasures/pull/983>`_]
* Support defining the ``site-power-capacity``, ``site-consumption-capacity`` and ``site-production-capacity`` as a sensor in the API and CLI [see `PR 985 <https://github.com/FlexMeasures/flexmeasures/pull/985>`_]
* Support defining the ``soc-minima``, ``soc-maxima`` and ``soc-targets`` as sensors in the API [see `PR 996 <https://github.com/FlexMeasures/flexmeasures/pull/996>`_]
* Support defining inflexible power sensors with arbitrary power and energy units [see `PR 1007 <https://github.com/FlexMeasures/flexmeasures/pull/1007>`_]
* Support saving beliefs with a ``belief_horizon`` in the ``PandasReporter``[see `PR 1013 <https://github.com/FlexMeasures/flexmeasures/pull/1013>`_]
* Skip the check of the output event resolution in any ``Reporter`` with the field ``check_output_resolution`` [see `PR 1009 <https://github.com/FlexMeasures/flexmeasures/pull/1009>`_]

Bugfixes
-----------

* Use minimum event resolution of the input (instead of the output) sensors for the belief search parameters [see `PR 1010 <https://github.com/FlexMeasures/flexmeasures/pull/1010>`_]

Infrastructure / Support
----------------------

* Align map layers with custom asset types in the UI's dashboard, also facilitating capturing asset types defined within FlexMeasures plugins [see `PR 1017 <https://github.com/FlexMeasures/flexmeasures/pull/1017>`_]
* Improve processing time for deleting beliefs via CLI [see `PR 1005 <https://github.com/FlexMeasures/flexmeasures/pull/1005>`_]
* Support deleting beliefs via CLI for all offspring assets at once [see `PR 1003 <https://github.com/FlexMeasures/flexmeasures/pull/1003>`_]
* Add setting ``FLEXMEASURES_FORCE_HTTPS`` to explicitly toggle if HTTPS should be used for all requests [see `PR 1008 <https://github.com/FlexMeasures/flexmeasures/pull/1008>`_]
* Make flexmeasures installable locally on macOS [see `PR 1000 <https://github.com/FlexMeasures/flexmeasures/pull/1000>`_]
* Align API endpoint policy w.r.t. trailing slash [see `PR 1014 <https://github.com/FlexMeasures/flexmeasures/pull/1014>`_]

============================

.. note:: Optionally, run ``flexmeasures db upgrade`` after upgrading to this version for enhanced database performance on time series queries.

* Upgrade timely-beliefs to enhance our main time series query and fix a database index on time series data, leading to significantly better performance [see `PR 992 <https://github.com/FlexMeasures/flexmeasures/pull/992>`_]
* Fix server error on loading the asset page for a public asset, due to a bug in the breadcrumb's sibling navigation [see `PR 991 <https://github.com/FlexMeasures/flexmeasures/pull/991>`_]
* Restore compatibility with the `flexmeasures-openweathermap plugin <https://github.com/SeitaBV/flexmeasures-openweathermap>`_ by fixing the query for the closest weather sensor to a given asset [see `PR #997 <https://github.com/FlexMeasures/flexmeasures/pull/997>`_]

============================

* Support defining the ``power-capacity`` as a sensor in the API and CLI [see `PR 987 <https://github.com/FlexMeasures/flexmeasures/pull/987>`_]

============================

.. note:: Read more on these features on `the FlexMeasures blog <https://flexmeasures.io/019-asset-nesting/>`__.

.. warning:: This version replaces FLASK_ENV with FLEXMEASURES_ENV (FLASK_ENV will still be used as a fallback).

New features
-------------

* List child assets on the asset page [see `PR 967 <https://github.com/FlexMeasures/flexmeasures/pull/967>`_]
* Expand the UI's breadcrumb functionality with the ability to navigate directly to sibling assets and sensors using their child-parent relationship [see `PR 977 <https://github.com/FlexMeasures/flexmeasures/pull/977>`_]
* Enable the use of QuantityOrSensor fields for the ``flexmeasures add schedule for-storage`` CLI command [see `PR 966 <https://github.com/FlexMeasures/flexmeasures/pull/966>`_]
* CLI support for showing/savings time series data for a given type of source only, with the new ``--source-type`` option of ``flexmeasures show beliefs``, which let's you filter out schedules, forecasts, or data POSTed by users (through the API), which each have a different source type [see `PR 976 <https://github.com/FlexMeasures/flexmeasures/pull/976>`_]
* New CLI command ``flexmeasures delete beliefs`` to delete all beliefs on a given sensor (or multiple sensors) or on sensors of a given asset (or multiple assets) [see `PR 975 <https://github.com/FlexMeasures/flexmeasures/pull/975>`_]
* Support for defining the storage efficiency as a sensor or quantity for the ``StorageScheduler`` [see `PR 965 <https://github.com/FlexMeasures/flexmeasures/pull/965>`_]
* Support a less verbose way of setting the same :abbr:`SoC (state of charge)` constraint for a given time window [see `PR 899 <https://github.com/FlexMeasures/flexmeasures/pull/899>`_]


Infrastructure / Support
----------------------

* Deprecate use of flask's ``FLASK_ENV`` variable and replace it with ``FLEXMEASURES_ENV`` [see `PR 907 <https://github.com/FlexMeasures/flexmeasures/pull/907>`_]
* Streamline CLI option naming by favoring ``--<entity>`` over ``--<entity>-id`` [see `PR 946 <https://github.com/FlexMeasures/flexmeasures/pull/946>`_]
* Documentation: improve index page, installation overview, feature overview incl. flex-model overview and UI screenshots [see `PR 953 <https://github.com/FlexMeasures/flexmeasures/pull/953>`_]
* Faster database queries of time series data by upgrading SQLAlchemy and timely-beliefs [see `PR 938 <https://github.com/FlexMeasures/flexmeasures/pull/938>`_]