Skip to content

Change Notebooks to local installation of latest dev state #690

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
gugrimm wants to merge 10 commits into
base: main
Choose a base branch
from
Open

Change Notebooks to local installation of latest dev state #690

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
bb25697
tried to fix amiris error
gugrimm Nov 21, 2025
e4b1a83
in notebooks if in COLAB change all !pip install 'assume-framework' t…
gugrimm Nov 21, 2025
7d8fbaa
reverted change in loader_amiris.py
gugrimm Nov 21, 2025
6e79b21
import amiris branch v4.0.0 instead of latest for the amiris example
gugrimm Nov 21, 2025
4c3d177
remove comment
gugrimm Nov 25, 2025
bd3d367
cleared outputs
gugrimm Nov 26, 2025
3ca4eb7
add depth=1 to amiris cloning
gugrimm Nov 26, 2025
3f5522a
reworked imports for notebook 03
gugrimm Nov 26, 2025
0b5877a
Merge remote-tracking branch 'origin/main' into notebook-fixes
gugrimm Dec 9, 2025
8b36941
changed setup in notebook 03 and 04a to local install
gugrimm Dec 10, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions examples/notebooks/01_minimal_manual_example.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -225,8 +225,8 @@
]
},
{
"metadata": {},
"cell_type": "markdown",
"metadata": {},
"source": [
"This code segment sets up a demand unit managed by the \"demand_operator\" unit operator, equipped with a naive demand forecast, and establishes its operational parameters within the electricity market simulation framework.\n",
"\n",
Expand All @@ -249,9 +249,9 @@
]
},
{
"metadata": {},
"cell_type": "code",
"execution_count": null,
"metadata": {},
"outputs": [],
"source": [
"world.add_unit_operator(\"unit_operator\")\n",
Expand Down Expand Up @@ -451,7 +451,7 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.12.12"
"version": "3.12.11"
},
"nbsphinx": {
"execute": "never"
Expand Down
2 changes: 1 addition & 1 deletion examples/notebooks/02_automated_run_example.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -527,7 +527,7 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.12.12"
"version": "3.12.11"
},
"nbsphinx": {
"execute": "never"
Expand Down
17 changes: 5 additions & 12 deletions examples/notebooks/03_custom_unit_example.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -133,17 +133,10 @@
"# Check if 'google.colab' is available\n",
"IN_COLAB = importlib.util.find_spec(\"google.colab\") is not None\n",
"if IN_COLAB:\n",
" !pip install assume-framework"
]
},
{
"cell_type": "code",
"execution_count": null,
"metadata": {},
"outputs": [],
"source": [
"if IN_COLAB:\n",
" !git clone --depth=1 https://github.com/assume-framework/assume.git assume-repo"
" # you can install the latest release of assume-framework with !pip install assume-framework\n",
Copy link
Contributor

@kim-mskw kim-mskw Nov 25, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we not do this consistently, then, to avoid future errors? If we decide to install the dev state, do we always?

" # however, in this tutorial we want to use the latest development version from github\n",
" !git clone --depth=1 https://github.com/assume-framework/assume.git assume-repo\n",
" !pip install -e assume-repo"
]
},
{
Expand Down Expand Up @@ -1245,7 +1238,7 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.12.12"
"version": "3.12.11"
},
"nbsphinx": {
"execute": "never"
Expand Down
4 changes: 2 additions & 2 deletions examples/notebooks/04a_reinforcement_learning_algorithm_example.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,6 @@
"IN_COLAB = importlib.util.find_spec(\"google.colab\") is not None\n",
"\n",
"if IN_COLAB:\n",
" !pip install assume-framework[learning]\n",
" # Colab currently has issues with pyomo version 6.8.2, causing the notebook to crash\n",
" # Installing an older version resolves this issue. This should only be considered a temporary fix.\n",
" !pip install pyomo==6.8.0"
Expand Down Expand Up @@ -119,7 +118,8 @@
"outputs": [],
"source": [
"if IN_COLAB:\n",
" !git clone --depth=1 https://github.com/assume-framework/assume.git assume-repo"
" !git clone --depth=1 https://github.com/assume-framework/assume.git assume-repo\n",
" !pip install -e ./assume-repo[learning]"
Copy link
Contributor

@kim-mskw kim-mskw Nov 25, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It is weird that we do not install assume in the section that is called installation process. I would suggest restructuring the chapter as well

]
},
{
Expand Down
7 changes: 4 additions & 3 deletions examples/notebooks/04b_reinforcement_learning_example.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -166,7 +166,8 @@
"source": [
"# Only run this cell if you are using Google Colab\n",
"if IN_COLAB:\n",
" !git clone --depth=1 https://github.com/assume-framework/assume.git assume-repo"
" !git clone --depth=1 https://github.com/assume-framework/assume.git assume-repo\n",
Copy link
Contributor

@kim-mskw kim-mskw Nov 25, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The installation command in the markdown cell still references the normal installation, there also with ". -e" then?

Copy link
Contributor

@kim-mskw kim-mskw Nov 25, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This happens in multiple tutorials. Please make changes accordingly.

" !pip install -e assume-repo"
]
},
{
Expand Down Expand Up @@ -1845,7 +1846,7 @@
],
"metadata": {
"kernelspec": {
"display_name": "assume-framework",
"display_name": "assume",
"language": "python",
"name": "python3"
},
Expand All @@ -1859,7 +1860,7 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.11.9"
"version": "3.12.11"
}
},
"nbformat": 4,
Expand Down
7 changes: 4 additions & 3 deletions examples/notebooks/04c_reinforcement_learning_storage_example.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -154,7 +154,8 @@
"source": [
"# Only run this cell if you are using Google Colab\n",
"if IN_COLAB:\n",
" !git clone --depth=1 https://github.com/assume-framework/assume.git assume-repo"
" !git clone --depth=1 https://github.com/assume-framework/assume.git assume-repo\n",
" !pip install -e assume-repo"
]
},
{
Expand Down Expand Up @@ -1987,7 +1988,7 @@
],
"metadata": {
"kernelspec": {
"display_name": "assume-framework",
"display_name": "assume",
"language": "python",
"name": "python3"
},
Expand All @@ -2001,7 +2002,7 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.11.9"
"version": "3.12.11"
}
},
"nbformat": 4,
Expand Down
7 changes: 3 additions & 4 deletions examples/notebooks/05_market_comparison.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,8 +79,6 @@
"# Check if 'google.colab' is available\n",
"IN_COLAB = importlib.util.find_spec(\"google.colab\") is not None\n",
"\n",
"if IN_COLAB:\n",
" !pip install assume-framework\n",
"!pip install matplotlib"
]
},
Expand All @@ -98,7 +96,8 @@
"outputs": [],
"source": [
"if IN_COLAB:\n",
" !git clone --depth=1 https://github.com/assume-framework/assume.git assume-repo"
" !git clone --depth=1 https://github.com/assume-framework/assume.git assume-repo\n",
" !pip install -e assume-repo"
Copy link
Contributor

@kim-mskw kim-mskw Nov 25, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Adjust the comment above that the code does not need to be executed when one has the current dev state installed, not the release.

]
},
{
Expand Down Expand Up @@ -538,7 +537,7 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.12.7"
"version": "3.12.11"
},
"nbsphinx": {
"execute": "never"
Expand Down
7 changes: 3 additions & 4 deletions examples/notebooks/06_advanced_orders_example.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -138,9 +138,7 @@
"import importlib.util\n",
"\n",
"# Check if 'google.colab' is available\n",
"IN_COLAB = importlib.util.find_spec(\"google.colab\") is not None\n",
"if IN_COLAB:\n",
" !pip install 'assume-framework'"
"IN_COLAB = importlib.util.find_spec(\"google.colab\") is not None"
]
},
{
Expand All @@ -157,7 +155,8 @@
"outputs": [],
"source": [
"if IN_COLAB:\n",
" !git clone --depth=1 https://github.com/assume-framework/assume.git assume-repo"
" !git clone --depth=1 https://github.com/assume-framework/assume.git assume-repo\n",
" !pip install -e assume-repo"
]
},
{
Expand Down
Loading