Skip to content

Commit

Permalink
updated toy-tutorial screenshots (#687)
Browse files Browse the repository at this point in the history
* updated toy-tutorial screenshots

Signed-off-by: Ahmad <ahmedwahid16101@gmail.com>

* updated screenshots names

Signed-off-by: Ahmad <ahmedwahid16101@gmail.com>

* added new screenshots with some intro

Signed-off-by: Ahmad <ahmedwahid16101@gmail.com>

* reverted the text and update asset view dashboard link

Signed-off-by: Ahmad Wahid <59763365+Ahmad-Wahid@users.noreply.github.com>

* updated text and removed dashboard

Signed-off-by: Ahmad Wahid <59763365+Ahmad-Wahid@users.noreply.github.com>

---------

Signed-off-by: Ahmad <ahmedwahid16101@gmail.com>
Signed-off-by: Ahmad Wahid <59763365+Ahmad-Wahid@users.noreply.github.com>
Co-authored-by: Nicolas Höning <nicolas@seita.nl>
  • Loading branch information
Ahmad-Wahid and nhoening committed May 24, 2023
1 parent 53df7c2 commit fe4c3a9
Showing 1 changed file with 26 additions and 3 deletions.
29 changes: 26 additions & 3 deletions documentation/tut/toy-example-from-scratch.rst
Original file line number Diff line number Diff line change
Expand Up @@ -179,10 +179,11 @@ Yes, that is quite a large battery :)
.. note:: Obviously, you can use the ``flexmeasures`` command to create your own, custom account and assets. See :ref:`cli`. And to create, edit or read asset data via the API, see :ref:`v3_0`.
We can also look at the battery asset in the UI of FlexMeasures (in Docker, the FlexMeasures web server already runs, on your PC you can start it with ``flexmeasures run``).
Visit `http://localhost:5000/assets <http://localhost:5000/assets>`_ (username is "toy-user@flexmeasures.io", password is "toy-password") and select "toy-battery":
Visit `http://localhost:5000/ <http://localhost:5000/>`_ (username is "toy-user@flexmeasures.io", password is "toy-password"):
.. image:: https://github.com/FlexMeasures/screenshots/raw/main/tut/toy-schedule/asset-view.png
.. image:: https://github.com/FlexMeasures/screenshots/raw/main/tut/toy-schedule/asset-view-dashboard.png
:align: center
|
.. note:: You won't see the map tiles, as we have not configured the :ref:`MAPBOX_ACCESS_TOKEN`. If you have one, you can configure it via ``flexmeasures.cfg`` (for Docker, see :ref:`docker_configuration`).
Expand Down Expand Up @@ -270,6 +271,7 @@ Again, we can also view these prices in the `FlexMeasures UI <http://localhost:5
.. image:: https://github.com/FlexMeasures/screenshots/raw/main/tut/toy-schedule/sensor-data-prices.png
:align: center
|
.. note:: Technically, these prices for tomorrow may be forecasts (depending on whether you are running through this tutorial before or after the day-ahead market's gate closure). You can also use FlexMeasures to compute forecasts yourself. See :ref:`tut_forecasting_scheduling`.
Expand Down Expand Up @@ -326,9 +328,15 @@ 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 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).
The `asset page for the battery <http://localhost:5000/assets/1/>`_ shows both prices and the schedule.
.. image:: https://github.com/FlexMeasures/screenshots/raw/main/tut/toy-schedule/asset-view-without-solar.png
:align: center
|
.. 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``.
Expand Down Expand Up @@ -383,7 +391,11 @@ Setting the data source type to "forecaster" helps FlexMeasures to visualize dis
$ flexmeasures add beliefs --sensor-id 3 --source 4 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.
The one-hour CSV data is automatically resampled to the 15-minute resolution of the sensor that is recording solar production. We can see solar production in the `FlexMeasures UI <http://localhost:5000/sensors/3/>`_ :
.. image:: https://github.com/FlexMeasures/screenshots/raw/main/tut/toy-schedule/sensor-data-production.png
:align: center
|
.. 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``.
Expand All @@ -397,3 +409,14 @@ Now, we'll reschedule the battery while taking into account the solar production
--soc-at-start 50% --roundtrip-efficiency 90%
New schedule is stored.
We can see the updated scheduling in the `FlexMeasures UI <http://localhost:5000/sensors/1/>`_ :
.. image:: https://github.com/FlexMeasures/screenshots/raw/main/tut/toy-schedule/sensor-data-charging-with-solar.png
:align: center
|
The `asset page for the battery <http://localhost:5000/assets/1/>`_ now shows the solar data, too.
.. image:: https://github.com/FlexMeasures/screenshots/raw/main/tut/toy-schedule/asset-view-with-solar.png
:align: center
|

0 comments on commit fe4c3a9

Please sign in to comment.