Documentation of Unit example (#262)

This commit adds new tutorial on adding custom unit and custom bidding strategy. --------- Co-authored-by: Nick Harder <[email protected]>
assume-framework · Jan 23, 2024 · 3328c38 · 3328c38
1 parent f5471f5
commit 3328c38
Show file tree

Hide file tree

Showing 18 changed files with 801 additions and 725 deletions.
diff --git a/assume/__init__.py b/assume/__init__.py
@@ -5,6 +5,11 @@
 from importlib.metadata import version
 
 from assume.common import MarketConfig, MarketProduct
+from assume.scenario.loader_csv import (
+    load_custom_units,
+    load_scenario_folder,
+    run_learning,
+)
 from assume.world import World
 
 __version__ = version("assume-framework")

diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -27,7 +27,7 @@
     "sphinx.ext.napoleon",
     "nbsphinx",
     "nbsphinx_link",
-    "sphinx.ext.imgconverter",  # for SVG conversion
+    # "sphinx.ext.imgconverter",  # for SVG conversion
 ]
 
 intersphinx_mapping = {

diff --git a/docs/source/examples/03_custom_unit_example.nblink b/docs/source/examples/03_custom_unit_example.nblink
@@ -0,0 +1 @@
+{"path": "../../../examples/notebooks/03_custom_unit_example.ipynb"}
diff --git a/...mples/06_market_comparison.nblink.license → ...les/03_custom_unit_example.nblink.license b/...mples/06_market_comparison.nblink.license → ...les/03_custom_unit_example.nblink.license
diff --git a/docs/source/examples/05_market_comparison.nblink b/docs/source/examples/05_market_comparison.nblink
@@ -0,0 +1 @@
+{"path": "../../../examples/notebooks/05_market_comparison.ipynb"}
diff --git a/...ebooks/06_market_comparison.ipynb.license → ...mples/05_market_comparison.nblink.license b/...ebooks/06_market_comparison.ipynb.license → ...mples/05_market_comparison.nblink.license
diff --git a/docs/source/examples/06_market_comparison.nblink b/docs/source/examples/06_market_comparison.nblink
diff --git a/docs/source/examples_basic.rst b/docs/source/examples_basic.rst
@@ -16,5 +16,6 @@ Here you can find several tutorials on how to use ASSUME framework to get you st
 
    examples/01_minimal_manual_example.nblink
    examples/02_automated_run_example.nblink
+   examples/03_custom_unit_example.nblink
    examples/04_reinforcement_learning_example.nblink
-   examples/06_market_comparison.nblink
+   examples/05_market_comparison.nblink
diff --git a/docs/source/img/Electrolyzer.png b/docs/source/img/Electrolyzer.png
diff --git a/docs/source/img/Electrolyzer.png.license b/docs/source/img/Electrolyzer.png.license
@@ -0,0 +1,3 @@
+SPDX-FileCopyrightText: ASSUME Developers
+
+SPDX-License-Identifier: AGPL-3.0-or-later
diff --git a/examples/inputs/example_03a/config.yaml b/examples/inputs/example_03a/config.yaml
@@ -4,7 +4,7 @@
 
 base:
   start_date: 2019-01-01 00:00
-  end_date: 2019-01-31 00:00
+  end_date: 2019-01-30 00:00
   time_step: 1h
   save_frequency_hours: 24
 

diff --git a/examples/notebooks/01_minimal_manual_example.ipynb b/examples/notebooks/01_minimal_manual_example.ipynb
@@ -447,7 +447,7 @@
             "name": "python",
             "nbconvert_exporter": "python",
             "pygments_lexer": "ipython3",
-            "version": "3.11.4"
+            "version": "3.11.3"
         },
         "nbsphinx": {
             "execute": "never"

diff --git a/examples/notebooks/02_automated_run_example.ipynb b/examples/notebooks/02_automated_run_example.ipynb
@@ -289,7 +289,7 @@
     "config_data = {\n",
     "    \"hourly_market\": {\n",
     "        \"start_date\": \"2021-03-01 00:00\",\n",
-    "        \"end_date\": \"2021-03-08 00:00\",\n",
+    "        \"end_date\": \"2021-03-07 00:00\",\n",
     "        \"time_step\": \"1h\",\n",
     "        \"save_frequency_hours\": 24,\n",
     "        \"markets_config\": {\n",
@@ -409,7 +409,7 @@
     "new_market_config = {\n",
     "    \"daily_market\": {\n",
     "        \"start_date\": \"2021-03-01 00:00\",\n",
-    "        \"end_date\": \"2021-03-08 00:00\",\n",
+    "        \"end_date\": \"2021-03-07 00:00\",\n",
     "        \"time_step\": \"1h\",\n",
     "        \"save_frequency_hours\": 24,\n",
     "        \"markets_config\": {\n",

diff --git a/examples/notebooks/03_custom_unit_example.ipynb b/examples/notebooks/03_custom_unit_example.ipynb
diff --git a/examples/notebooks/03_custom_unit_example.ipynb.license b/examples/notebooks/03_custom_unit_example.ipynb.license
@@ -0,0 +1,3 @@
+SPDX-FileCopyrightText: ASSUME Developers
+
+SPDX-License-Identifier: AGPL-3.0-or-later
diff --git a/examples/notebooks/04_reinforcement_learning_example.ipynb b/examples/notebooks/04_reinforcement_learning_example.ipynb
@@ -238,7 +238,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": null,
+   "execution_count": 1,
    "metadata": {
     "id": "xUsbeZdPJ_2Q"
    },
@@ -264,7 +264,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": null,
+   "execution_count": 2,
    "metadata": {
     "id": "UXYSesx4Ifp5"
    },
@@ -355,11 +355,19 @@
   },
   {
    "cell_type": "code",
-   "execution_count": null,
+   "execution_count": 5,
    "metadata": {
     "id": "iApbQsg5x_u2"
    },
-   "outputs": [],
+   "outputs": [
+    {
+     "name": "stderr",
+     "output_type": "stream",
+     "text": [
+      "UsageError: Line magic function `%%add_to` not found.\n"
+     ]
+    }
+   ],
    "source": [
     "# magic to enable class definitions across colab cells\n",
     "%%add_to RLStrategy\n",
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		{"path": "../../../examples/notebooks/03_custom_unit_example.ipynb"}
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		{"path": "../../../examples/notebooks/05_market_comparison.ipynb"}
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		SPDX-FileCopyrightText: ASSUME Developers

		SPDX-License-Identifier: AGPL-3.0-or-later