Merge pull request #258 from assume-framework/add-collab-tonotebooks

Add collab tonotebooks
assume-framework · Dec 6, 2023 · 357f0ba · 357f0ba
2 parents afae9d8 + b717ee6
commit 357f0ba
Show file tree

Hide file tree

Showing 9 changed files with 1,814 additions and 445 deletions.
diff --git a/README.md b/README.md
@@ -17,7 +17,7 @@ SPDX-License-Identifier: AGPL-3.0-or-later
 [![](https://img.shields.io/pypi/status/assume-framework.svg)](https://pypi.org/pypi/assume-framework/)
 [![](https://img.shields.io/readthedocs/assume)](https://assume.readthedocs.io/)
 
-[![Open Tutorials In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/drive/1LISiM1QvDIMXU68pJH-NqrMw5w7Awb24?usp=sharing)
+[![Try examples in Collab](https://colab.research.google.com/assets/colab-badge.svg)](https://github.com/assume-framework/assume/tree/main/examples/notebooks)
 
 **ASSUME** is an open-source toolbox for agent-based simulations of European electricity markets, with a primary focus on the German market setup. Developed as an open-source model, its primary objectives are to ensure usability and customizability for a wide range of users and use cases in the energy system modeling community.
 

diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -75,6 +75,7 @@
 .. note::
 
     You can `download <https://github.com/assume-framework/assume/tree/main/{{ docname }}>`_ this example as a Jupyter notebook
+    or try it out directly in `Google Colab <https://colab.research.google.com/github/assume-framework/assume/blob/main/{{ docname }}>`_.
 """
 
 nbsphinx_allow_errors = True
diff --git a/docs/source/examples/04_Reinforcement_learning_example.nblink b/docs/source/examples/04_Reinforcement_learning_example.nblink
@@ -0,0 +1 @@
+{"path": "../../../examples/notebooks/04_Reinforcement_learning_example.ipynb"}
diff --git a/docs/source/examples/04_Reinforcement_learning_example.nblink.license b/docs/source/examples/04_Reinforcement_learning_example.nblink.license
@@ -0,0 +1,3 @@
+SPDX-FileCopyrightText: ASSUME Developers
+
+SPDX-License-Identifier: AGPL-3.0-or-later
diff --git a/docs/source/examples_basic.rst b/docs/source/examples_basic.rst
@@ -7,10 +7,11 @@ Basic Usage
 ############
 
 
-Here you can find several examples for basic usage of ASSUME framework to get you started:
+Here you can find several examples for usage of ASSUME framework to get you started:
 
 
 .. toctree::
    :maxdepth: 1
 
    examples/01_minimal_manual_example.ipynb
+   examples/04_Reinforcement_learning_example.ipynb
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		{"path": "../../../examples/notebooks/04_Reinforcement_learning_example.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