481 extend documentation and toy tutorial with scheduling within the context of a building with PV

documentation/tut/toy-example-from-scratch.rst

@@ -19,7 +19,7 @@ Below are the ``flexmeasures`` CLI commands we'll run, and which we'll explain s
     # setup an account with a user, a battery (Id 2) and a market (Id 3)
     $ flexmeasures add toy-account --kind battery
     # load prices to optimise the schedule against
-    $ flexmeasures add beliefs --sensor-id 3 --source toy-user prices-tomorrow.csv --timezone utc
+    $ flexmeasures add beliefs --sensor-id 3 --source toy-user prices-tomorrow.csv --timezone Europe/Amsterdam
     # make the schedule
     $ flexmeasures add schedule for-storage --sensor-id 2 --consumption-price-sensor 3 \
         --start ${TOMORROW}T07:00+01:00 --duration PT12H \
@@ -108,8 +108,9 @@ FlexMeasures offers a command to create a toy account with a battery:
     $ flexmeasures add toy-account --kind battery
 
     Toy account Toy Account with user toy-user@flexmeasures.io created successfully. You might want to run `flexmeasures show account --id 1`
-    The sensor for battery (dis)charging is <Sensor 2: discharging, unit: MW res.: 0:15:00>.
-    The sensor for Day ahead prices is <Sensor 3: Day ahead prices, unit: EUR/MWh res.: 1:00:00>.
+    The sensor recording battery power is <Sensor 2: discharging, unit: MW res.: 0:15:00>.
+    The sensor recording day-ahead prices is <Sensor 3: day-ahead prices, unit: EUR/MWh res.: 1:00:00>.
+    The sensor recording solar forecasts is <Sensor 4: production, unit: MW res.: 0:15:00>.
 
 And with that, we're done with the structural data for this tutorial! 
 
@@ -211,42 +212,42 @@ This is time series data, in FlexMeasures we call "beliefs". Beliefs can also be
 
 .. code-block:: console
 
-    $ flexmeasures add beliefs --sensor-id 3 --source toy-user prices-tomorrow.csv --timezone utc
+    $ flexmeasures add beliefs --sensor-id 3 --source toy-user prices-tomorrow.csv --timezone Europe/Amsterdam
     Successfully created beliefs
 
 In FlexMeasures, all beliefs have a data source. Here, we use the username of the user we created earlier. We could also pass a user ID, or the name of a new data source we want to use for CLI scripts.
 
-.. note:: Attention: We created and imported prices where the times have no time zone component! That happens a lot. Here, we localized the data to UTC time. So if you are in Amsterdam time, the start time for the first price, when expressed in your time zone, is actually `2022-03-03 01:00:00+01:00`.
+.. note:: Attention: We created and imported prices where the times have no time zone component! That happens a lot. FlexMeasures can localize them for you to a given timezone. Here, we localized the data to the timezone of the price sensor - ``Europe/Amsterdam`` - so the start time for the first price is `2022-03-03 00:00:00+01:00` (midnight in Amsterdam).
 
 Let's look at the price data we just loaded:
 
 .. code-block:: console
 
-    $ flexmeasures show beliefs --sensor-id 3 --start ${TOMORROW}T01:00:00+01:00 --duration PT24H
-    Beliefs for Sensor 'Day ahead prices' (Id 3).
-    Data spans a day and starts at 2022-03-03 01:00:00+01:00.
+    $ flexmeasures show beliefs --sensor-id 3 --start ${TOMORROW}T00:00:00+01:00 --duration PT24H
+    Beliefs for Sensor 'day-ahead prices' (Id 3).
+    Data spans a day and starts at 2022-03-03 00:00:00+01:00.
     The time resolution (x-axis) is an hour.
     ┌────────────────────────────────────────────────────────────┐
     │         ▗▀▚▖                                               │ 18EUR/MWh
-    │         ▞  ▝▌                                              │ 
-    │        ▐    ▚                                              │ 
-    │       ▗▘    ▐                                              │ 
-    │       ▌      ▌                                     ▖       │ 
-    │      ▞       ▚                                  ▗▄▀▝▄      │ 
+    │         ▞  ▝▌                                              │
+    │        ▐    ▚                                              │
+    │       ▗▘    ▐                                              │
+    │       ▌      ▌                                     ▖       │
+    │      ▞       ▚                                  ▗▄▀▝▄      │
     │     ▗▘       ▐                                ▗▞▀    ▚     │ 13EUR/MWh
-    │   ▗▄▘         ▌                              ▐▘       ▚    │ 
-    │ ▗▞▘           ▚                              ▌         ▚   │ 
-    │▞▘             ▝▄           ▗                ▐          ▝▖  │ 
-    │                 ▚▄▄▀▚▄▄   ▞▘▚               ▌           ▝▖ │ 
-    │                        ▀▀▛   ▚             ▐             ▚ │ 
+    │   ▗▄▘         ▌                              ▐▘       ▚    │
+    │ ▗▞▘           ▚                              ▌         ▚   │
+    │▞▘             ▝▄           ▗                ▐          ▝▖  │
+    │                 ▚▄▄▀▚▄▄   ▞▘▚               ▌           ▝▖ │
+    │                        ▀▀▛   ▚             ▐             ▚ │
     │                               ▚           ▗▘              ▚│ 8EUR/MWh
-    │                                ▌         ▗▘               ▝│ 
-    │                                ▝▖        ▞                 │ 
-    │                                 ▐▖     ▗▀                  │ 
-    │                                  ▝▚▄▄▄▄▘                   │ 
+    │                                ▌         ▗▘               ▝│
+    │                                ▝▖        ▞                 │
+    │                                 ▐▖     ▗▀                  │
+    │                                  ▝▚▄▄▄▄▘                   │
     └────────────────────────────────────────────────────────────┘
-            5           10           15           20
-                        ██ Day ahead prices
+               5           10           15           20
+                         ██ day-ahead prices
 
 
 
@@ -282,26 +283,26 @@ Great. Let's see what we made:
     Data spans 12 hours and starts at 2022-03-04 07:00:00+01:00.
     The time resolution (x-axis) is 15 minutes.
     ┌────────────────────────────────────────────────────────────┐
-    │   ▐                      ▐▀▀▌                           ▛▀▀│ 
-    │   ▞▌                     ▞  ▐                           ▌  │ 0.4MW
-    │   ▌▌                     ▌  ▐                          ▐   │ 
-    │  ▗▘▌                     ▌  ▐                          ▐   │ 
-    │  ▐ ▐                    ▗▘  ▝▖                         ▐   │ 
-    │  ▞ ▐                    ▐    ▌                         ▌   │ 0.2MW
-    │ ▗▘ ▐                    ▐    ▌                         ▌   │ 
-    │ ▐  ▝▖                   ▌    ▚                        ▞    │ 
-    │▀▘───▀▀▀▀▀▀▀▀▀▀▀▀▀▀▌────▐─────▝▀▀▀▀▀▀▀▀▜─────▐▀▀▀▀▀▀▀▀▀─────│ 0MW
-    │                   ▌    ▞              ▐    ▗▘              │ 
-    │                   ▚    ▌              ▐    ▐               │ 
-    │                   ▐   ▗▘              ▝▖   ▌               │ -0.2MW
-    │                   ▐   ▐                ▌   ▌               │ 
-    │                   ▐   ▐                ▌  ▗▘               │ 
-    │                    ▌  ▞                ▌  ▐                │ 
-    │                    ▌  ▌                ▐  ▐                │ -0.4MW
-    │                    ▙▄▄▌                ▐▄▄▞                │ 
+    │        ▐▌           ▐▀▀▌                                ▛▀▀│
+    │        ▐▌           ▞  ▚                                ▌  │ 0.4MW
+    │        ▌▌           ▌  ▐                               ▗▘  │
+    │        ▌▚           ▌  ▐                               ▐   │
+    │       ▗▘▐          ▗▘  ▐                               ▐   │
+    │       ▐ ▐          ▐    ▌                              ▞   │ 0.2MW
+    │       ▌ ▐          ▐    ▌                              ▌   │
+    │      ▗▘  ▌         ▐    ▌                              ▌   │
+    │▀▀▀▀▀▀▀───▀▀▀▀▌─────▌────▝▀▀▀▀▀▀▀▀▌─────▐▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▘───│ 0MW
+    │              ▌    ▗▘             ▐     ▞                   │
+    │              ▌    ▐              ▐    ▗▘                   │
+    │              ▚    ▌              ▐    ▐                    │ -0.2MW
+    │              ▐   ▗▘               ▌   ▌                    │
+    │              ▐   ▐                ▌   ▌                    │
+    │              ▝▖  ▞                ▌  ▐                     │
+    │               ▌  ▌                ▚  ▐                     │ -0.4MW
+    │               ▙▄▄▘                ▐▄▄▌                     │
     └────────────────────────────────────────────────────────────┘
-            10           20           30          40
-                            ██ discharging
+               10           20           30          40
+                             ██ discharging
 
 
 Here, negative values denote output from the grid, so that's when the battery gets charged. 
@@ -311,7 +312,66 @@ We can also look at the charging schedule in the `FlexMeasures UI <http://localh
 .. image:: https://github.com/FlexMeasures/screenshots/raw/main/tut/toy-schedule/sensor-data-charging.png
     :align: center
 
-Recall that we only asked for a 12 hour schedule here. We started our schedule *after* the high price peak (at 5am) and it also had to end *before* the second price peak fully realised (at 9pm). Our scheduler didn't have many opportunities to optimize, but it found some. For instance, it does buy at the lowest price (around 3pm) and sells it off when prices start rising again (around 6pm).
+Recall that we only asked for a 12 hour schedule here. We started our schedule *after* the high price peak (at 4am) and it also had to end *before* the second price peak fully realised (at 8pm). Our scheduler didn't have many opportunities to optimize, but it found some. For instance, it does buy at the lowest price (at 2pm) and sells it off at the highest price within the given 12 hours (at 6pm).
 
 
-.. note:: The ``flexmeasures add schedule for-storage`` command also accepts state-of-charge targets, so the schedule can be more sophisticated. But that is not the point of this tutorial. See ``flexmeasures add schedule for-storage --help``. 
+.. note:: The ``flexmeasures add schedule for-storage`` command also accepts state-of-charge targets, so the schedule can be more sophisticated. But that is not the point of this tutorial. See ``flexmeasures add schedule for-storage --help``.
+
+
+Take into account solar production
+---------------------------------------
+
+First, we'll create a new csv file with solar forecasts (MW, see the setup for sensor 4 above) for tomorrow.
+
+.. code-block:: console
+
+    $ TOMORROW=$(date --date="next day" '+%Y-%m-%d')
+    $ echo "Hour,Price
+    $ ${TOMORROW}T00:00:00,0.0
+    $ ${TOMORROW}T01:00:00,0.0
+    $ ${TOMORROW}T02:00:00,0.0
+    $ ${TOMORROW}T03:00:00,0.0
+    $ ${TOMORROW}T04:00:00,0.01
+    $ ${TOMORROW}T05:00:00,0.03
+    $ ${TOMORROW}T06:00:00,0.06
+    $ ${TOMORROW}T07:00:00,0.1
+    $ ${TOMORROW}T08:00:00,0.14
+    $ ${TOMORROW}T09:00:00,0.17
+    $ ${TOMORROW}T10:00:00,0.19
+    $ ${TOMORROW}T11:00:00,0.21
+    $ ${TOMORROW}T12:00:00,0.22
+    $ ${TOMORROW}T13:00:00,0.21
+    $ ${TOMORROW}T14:00:00,0.19
+    $ ${TOMORROW}T15:00:00,0.17
+    $ ${TOMORROW}T16:00:00,0.14
+    $ ${TOMORROW}T17:00:00,0.1
+    $ ${TOMORROW}T18:00:00,0.06
+    $ ${TOMORROW}T19:00:00,0.03
+    $ ${TOMORROW}T20:00:00,0.01
+    $ ${TOMORROW}T21:00:00,0.0
+    $ ${TOMORROW}T22:00:00,0.0
+    $ ${TOMORROW}T23:00:00,0.0" > solar-tomorrow.csv
+
+Then, we register a new forecaster and read in the created CSV file as beliefs data:
+
+.. code-block:: console
+
+    $ flexmeasures add source --name "toy-forecaster" --type forecaster
+    Added source <Data source 2 (toy-forecaster)>
+    $ flexmeasures add beliefs --sensor-id 4 --source 2 solar-tomorrow.csv --timezone Europe/Amsterdam
+    Successfully created beliefs
+
+The one-hour CSV data is automatically resampled to the 15-minute resolution of the sensor that is recording solar production.
+
+.. note:: The ``flexmeasures add beliefs`` command has many options to make sure the read-in data is correctly interpreted (unit, timezone, delimiter, etc). But that is not the point of this tutorial. See ``flexmeasures add beliefs --help``.
+
+Now, we'll reschedule the battery while taking into account the solar production. This will have an effect on the available headroom for the battery.
+
+.. code-block:: console
+
+    $ flexmeasures add schedule --sensor-id 2 --consumption-price-sensor 3 \
+        --inflexible-device-sensor 4 \
+        --start ${TOMORROW}T07:00+01:00 --duration PT12H \
+        --soc-at-start 50% --roundtrip-efficiency 90%
+    New schedule is stored.
+

flexmeasures/api/v3_0/assets.py

@@ -15,6 +15,7 @@
 from flexmeasures.data.schemas.generic_assets import GenericAssetSchema as AssetSchema
 from flexmeasures.api.common.schemas.generic_assets import AssetIdField
 from flexmeasures.api.common.schemas.users import AccountIdField
+from flexmeasures.utils.coding_utils import flatten_unique
 from flexmeasures.ui.utils.view_utils import set_time_range_for_session
 
 
@@ -309,5 +310,5 @@ def get_chart_data(self, id: int, asset: GenericAsset, **kwargs):
 
         Data for use in charts (in case you have the chart specs already).
         """
-        sensors = asset.sensors_to_show
+        sensors = flatten_unique(asset.sensors_to_show)
         return asset.search_beliefs(sensors=sensors, as_json=True, **kwargs)