deploy: 09bcc00

Illuminator-team · Nov 4, 2024 · 19464bc · 19464bc
commit 19464bc
Show file tree

Hide file tree

Showing 99 changed files with 12,560 additions and 0 deletions.
diff --git a/.buildinfo b/.buildinfo
@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: 84e2c76a5f957d4cd237c1d518258990
+tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/.doctrees/developer/start.doctree b/.doctrees/developer/start.doctree
diff --git a/.doctrees/environment.pickle b/.doctrees/environment.pickle
diff --git a/.doctrees/index.doctree b/.doctrees/index.doctree
diff --git a/.doctrees/nbsphinx/turotials/example.ipynb b/.doctrees/nbsphinx/turotials/example.ipynb
diff --git a/.doctrees/nbsphinx/turotials_example_13_0.png b/.doctrees/nbsphinx/turotials_example_13_0.png
diff --git a/.doctrees/nbsphinx/turotials_example_19_0.png b/.doctrees/nbsphinx/turotials_example_19_0.png
diff --git a/.doctrees/nbsphinx/turotials_example_7_0.png b/.doctrees/nbsphinx/turotials_example_7_0.png
diff --git a/.doctrees/quick-start.doctree b/.doctrees/quick-start.doctree
diff --git a/.doctrees/references/engine-api.doctree b/.doctrees/references/engine-api.doctree
diff --git a/.doctrees/references/models.doctree b/.doctrees/references/models.doctree
diff --git a/.doctrees/turotials/example.doctree b/.doctrees/turotials/example.doctree
diff --git a/.doctrees/user/models.doctree b/.doctrees/user/models.doctree
diff --git a/.doctrees/user/start.doctree b/.doctrees/user/start.doctree
diff --git a/.doctrees/user/user-guide.doctree b/.doctrees/user/user-guide.doctree
diff --git a/.nojekyll b/.nojekyll
diff --git a/_images/turotials_example_13_0.png b/_images/turotials_example_13_0.png
diff --git a/_images/turotials_example_19_0.png b/_images/turotials_example_19_0.png
diff --git a/_images/turotials_example_7_0.png b/_images/turotials_example_7_0.png
diff --git a/_sources/developer/start.md.txt b/_sources/developer/start.md.txt
@@ -0,0 +1,35 @@
+# Set Up Environment
+
+**Requirements**
+* Python >= 3.11
+* Recent version of PIP
+
+
+To set up a development environment:
+
+1. Clone the repository:
+
+```shell
+git clone git@github.com:Illuminator-team/Illuminator.git
+```
+
+2. Go the root tof the repository:
+
+```shell
+cd Illuminator/
+```
+
+3. install the development dependencies in editable mode:
+
+```shell 
+pip install -e .e
+```
+
+## Running Unit Tests
+
+We use `Pytest` to write and test the source code. To run all unit-tests, run the following command at the root of the repository:
+
+```
+pytest tests/
+```
+
diff --git a/_sources/index.rst.txt b/_sources/index.rst.txt
@@ -0,0 +1,56 @@
+.. Illuminator documentation master file, created by
+   sphinx-quickstart on Wed Jul 31 14:38:44 2024.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Illuminator documentation
+=========================
+
+
+The Illuminator is an easy-to-use Energy System Integration 
+Development kit to demystify energy system operation, illustrate challenges 
+that arise due to the energy transition and test 
+state-of-the-art energy management concepts. we utilise Raspberry Pis
+as the individual components of the energy system emulator, 
+and the simulation engine is based on `Mosaik. <https://mosaik.offis.de/>`_
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents
+
+   quick-start
+
+.. toctree::
+   :maxdepth: 2
+   :caption: User's Documentation
+
+   user/start
+   user/user-guide
+   user/models
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Tutorials
+
+   turotials/example.ipynb
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Developer's Documentation
+
+   developer/start
+
+
+.. toctree::
+   :maxdepth: 2
+   :caption: References
+
+   references/models.rst
+   references/engine-api.rst
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
diff --git a/_sources/quick-start.md.txt b/_sources/quick-start.md.txt
@@ -0,0 +1,3 @@
+# Quick Start
+
+> Comming soon...
diff --git a/_sources/references/engine-api.rst.txt b/_sources/references/engine-api.rst.txt
@@ -0,0 +1,11 @@
+Engine's API
+=====================
+
+.. automodule:: illuminator.engine 
+    :members:
+    :show-inheritance:
+
+
+
+.. 
+    more about autodoc: https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html#module-sphinx.ext.autodoc
diff --git a/_sources/references/models.rst.txt b/_sources/references/models.rst.txt
@@ -0,0 +1,10 @@
+Illumator Models
+=====================
+
+.. autoclass:: illuminator.models.Battery.battery_model::BatteryModel
+   :members:
+   :undoc-members:  this not necessary when docstrings are written
+
+
+.. 
+    more about autodoc: https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html#module-sphinx.ext.autodoc
diff --git a/_sources/turotials/example.ipynb.txt b/_sources/turotials/example.ipynb.txt