Tutorials Overview
The following educational material includes interactive exercises in order to introduce users to different aspects of energy systems using the Illuminator.
List of Tutorials
Note
If you wish to recommend improvements or participate in the development of educational material with the Illuminator feel free to contact the Illuminator Development Team.
Tutorial Instructions
There are two ways to run the Illuminator tutorials currently: Locally and on web, we recomment the former for users who plan on using the Illuminator software actively and the latter for educators or students who wish to familiarise themselves with energy system interactions and not the software itself.
Running Tutorials Locally
We endorse any aspiring Illuminator developers to run the tutorials locally. This will serve as an excellent starting point in familiarising yourself with the configuration file, set up and structure of the Illuminator.
Make sure you have Illuminator installed in your system.
Download the tutorial contents by clicking the
Download ZIPbutton.Extract the files and open the tutorial notebook (ipynb).
Run the cells, the notebook itself executes the simulations and allows you to make changes in the configuration file of the simulation (yaml) through simple functions.
Running Tutorials on Web (Colab)
This serves as an excellent starting point if you do not have python in your system, since you can run everything remotely. You do not need to download the jupyter notebook as it is hosted online in github and can be accessed within the colab environment.
Make sure you have internet access.
Click the
Open in Colabbutton.Run the cells, the colab environment executes the simulations and allows you to make changes in the configuration file of the simulation (yaml) through simple functions.
Note
As this is a web hosted environment, installing the Illuminator will take a few minutes. Once installation is complete you will be asked to restart your session. After that you may continue running the rest of the notebook cells.
Note
Any changes you make to the linked colab notebooks will be lost once your session has ended. The same is true for your uploaded files. If you wish to save your version of the notebook, make a copy of the colab notebook to your drive.


