From c600ab76cdc10be13f40b9173deb016afe8a7c09 Mon Sep 17 00:00:00 2001 From: "fabian.wuellhorst@eonerc.rwth-aachen.de" Date: Fri, 15 Nov 2024 09:39:12 +0000 Subject: [PATCH] chore(examples): Automatic commit of example files in Markdown and Jupyter Notebook format. --- docs/jupyter_notebooks/e1_generate_archetype.ipynb | 2 +- docs/jupyter_notebooks/e2_export_aixlib_models.ipynb | 2 +- docs/jupyter_notebooks/e3_export_ibpsa_models.ipynb | 2 +- docs/jupyter_notebooks/e4_save.ipynb | 2 +- docs/jupyter_notebooks/e5_load.ipynb | 2 +- docs/jupyter_notebooks/e6_generate_building.ipynb | 2 +- docs/jupyter_notebooks/e7_retrofit.ipynb | 2 +- docs/source/examples/e1_generate_archetype.md | 2 +- docs/source/examples/e2_export_aixlib_models.md | 2 +- docs/source/examples/e3_export_ibpsa_models.md | 2 +- docs/source/examples/e4_save.md | 2 +- docs/source/examples/e5_load.md | 2 +- docs/source/examples/e6_generate_building.md | 2 +- docs/source/examples/e7_retrofit.md | 2 +- 14 files changed, 14 insertions(+), 14 deletions(-) diff --git a/docs/jupyter_notebooks/e1_generate_archetype.ipynb b/docs/jupyter_notebooks/e1_generate_archetype.ipynb index 2bddd9bd9..34afbf5a4 100644 --- a/docs/jupyter_notebooks/e1_generate_archetype.ipynb +++ b/docs/jupyter_notebooks/e1_generate_archetype.ipynb @@ -3,7 +3,7 @@ { "cell_type": "markdown", "metadata": {}, - "source": "# Example 1: Generate archetype buildings using TEASER API\nThis module contains an example how to generate archetype buildings\nusing TEASER API functions.\nYou can run this example using the [jupyter-notebook](https://mybinder.org/v2/gh/RWTH-EBC/TEASER/master?labpath=docs%2Fjupyter_notebooks)\n" + "source": "# Example 1: Generate archetype buildings using TEASER API\nThis module contains an example how to generate archetype buildings\nusing TEASER API functions.\nYou can run this example using the [jupyter-notebook](https://mybinder.org/v2/gh/RWTH-EBC/TEASER/main?labpath=docs%2Fjupyter_notebooks)\n" }, { "cell_type": "markdown", diff --git a/docs/jupyter_notebooks/e2_export_aixlib_models.ipynb b/docs/jupyter_notebooks/e2_export_aixlib_models.ipynb index 4235cd3d9..3141d8592 100644 --- a/docs/jupyter_notebooks/e2_export_aixlib_models.ipynb +++ b/docs/jupyter_notebooks/e2_export_aixlib_models.ipynb @@ -8,7 +8,7 @@ { "cell_type": "markdown", "metadata": {}, - "source": "This module contains an example how to export buildings from a TEASER\nproject to ready-to-run simulation models for Modelica library AixLib. These\nmodels will only simulate using Dymola, the reason for this are state\nmachines that are used in one AixLib specific AHU model.\nYou can run this example using the [jupyter-notebook](https://mybinder.org/v2/gh/RWTH-EBC/TEASER/master?labpath=docs%2Fjupyter_notebooks)\n" + "source": "This module contains an example how to export buildings from a TEASER\nproject to ready-to-run simulation models for Modelica library AixLib. These\nmodels will only simulate using Dymola, the reason for this are state\nmachines that are used in one AixLib specific AHU model.\nYou can run this example using the [jupyter-notebook](https://mybinder.org/v2/gh/RWTH-EBC/TEASER/main?labpath=docs%2Fjupyter_notebooks)\n" }, { "cell_type": "code", diff --git a/docs/jupyter_notebooks/e3_export_ibpsa_models.ipynb b/docs/jupyter_notebooks/e3_export_ibpsa_models.ipynb index 1e304127a..bb74b0068 100644 --- a/docs/jupyter_notebooks/e3_export_ibpsa_models.ipynb +++ b/docs/jupyter_notebooks/e3_export_ibpsa_models.ipynb @@ -3,7 +3,7 @@ { "cell_type": "markdown", "metadata": {}, - "source": "# Example 3: Export Modelica models for IBPSA library using TEASER API\nThis module contains an example how to export buildings from a TEASER\nproject to ready-to-run simulation models for Modelica library IBPSA. These\nmodels simulate in Dymola, OpenModelica and JModelica.\nYou can run this example using the [jupyter-notebook](https://mybinder.org/v2/gh/RWTH-EBC/TEASER/master?labpath=docs%2Fjupyter_notebooks)\n" + "source": "# Example 3: Export Modelica models for IBPSA library using TEASER API\nThis module contains an example how to export buildings from a TEASER\nproject to ready-to-run simulation models for Modelica library IBPSA. These\nmodels simulate in Dymola, OpenModelica and JModelica.\nYou can run this example using the [jupyter-notebook](https://mybinder.org/v2/gh/RWTH-EBC/TEASER/main?labpath=docs%2Fjupyter_notebooks)\n" }, { "cell_type": "code", diff --git a/docs/jupyter_notebooks/e4_save.ipynb b/docs/jupyter_notebooks/e4_save.ipynb index 46da3bc2c..141ba5abe 100644 --- a/docs/jupyter_notebooks/e4_save.ipynb +++ b/docs/jupyter_notebooks/e4_save.ipynb @@ -3,7 +3,7 @@ { "cell_type": "markdown", "metadata": {}, - "source": "# Example 4: Save information\nThis module contains an example how to save buildings from a TEASER\nproject to json and pickle in order to save information.\nYou can run this example using the [jupyter-notebook](https://mybinder.org/v2/gh/RWTH-EBC/TEASER/master?labpath=docs%2Fjupyter_notebooks)\n" + "source": "# Example 4: Save information\nThis module contains an example how to save buildings from a TEASER\nproject to json and pickle in order to save information.\nYou can run this example using the [jupyter-notebook](https://mybinder.org/v2/gh/RWTH-EBC/TEASER/main?labpath=docs%2Fjupyter_notebooks)\n" }, { "cell_type": "code", diff --git a/docs/jupyter_notebooks/e5_load.ipynb b/docs/jupyter_notebooks/e5_load.ipynb index f257a51b9..3389913d4 100644 --- a/docs/jupyter_notebooks/e5_load.ipynb +++ b/docs/jupyter_notebooks/e5_load.ipynb @@ -3,7 +3,7 @@ { "cell_type": "markdown", "metadata": {}, - "source": "# Example 5: Load information\nThis module contains an example how to import TEASER projects from\n`*.teaserjson` and pickle in order to reuse data.\nYou can run this example using the [jupyter-notebook](https://mybinder.org/v2/gh/RWTH-EBC/TEASER/master?labpath=docs%2Fjupyter_notebooks)\n" + "source": "# Example 5: Load information\nThis module contains an example how to import TEASER projects from\n`*.teaserjson` and pickle in order to reuse data.\nYou can run this example using the [jupyter-notebook](https://mybinder.org/v2/gh/RWTH-EBC/TEASER/main?labpath=docs%2Fjupyter_notebooks)\n" }, { "cell_type": "code", diff --git a/docs/jupyter_notebooks/e6_generate_building.ipynb b/docs/jupyter_notebooks/e6_generate_building.ipynb index 0eef51395..dea14bf6b 100644 --- a/docs/jupyter_notebooks/e6_generate_building.ipynb +++ b/docs/jupyter_notebooks/e6_generate_building.ipynb @@ -3,7 +3,7 @@ { "cell_type": "markdown", "metadata": {}, - "source": "# Example 7: Generate single building\nThis module contains an example that shows to create a building not using\nthe archetype approach but adding all information separately. In this example\nwe import all needed modules and classes where we need it in the code. For you\napplication we suggest to use PEP008 and import them at the beginning of the\nscript.\nYou can run this example using the [jupyter-notebook](https://mybinder.org/v2/gh/RWTH-EBC/TEASER/master?labpath=docs%2Fjupyter_notebooks)\n" + "source": "# Example 7: Generate single building\nThis module contains an example that shows to create a building not using\nthe archetype approach but adding all information separately. In this example\nwe import all needed modules and classes where we need it in the code. For you\napplication we suggest to use PEP008 and import them at the beginning of the\nscript.\nYou can run this example using the [jupyter-notebook](https://mybinder.org/v2/gh/RWTH-EBC/TEASER/main?labpath=docs%2Fjupyter_notebooks)\n" }, { "cell_type": "markdown", diff --git a/docs/jupyter_notebooks/e7_retrofit.ipynb b/docs/jupyter_notebooks/e7_retrofit.ipynb index 7478745c4..dcd45b318 100644 --- a/docs/jupyter_notebooks/e7_retrofit.ipynb +++ b/docs/jupyter_notebooks/e7_retrofit.ipynb @@ -3,7 +3,7 @@ { "cell_type": "markdown", "metadata": {}, - "source": "# Example 7: Retrofit buildings\nThis module contains an example that shows how to retrofit all buildings\nin a TEASER project with different setups\nYou can run this example using the [jupyter-notebook](https://mybinder.org/v2/gh/RWTH-EBC/TEASER/master?labpath=docs%2Fjupyter_notebooks)\n" + "source": "# Example 7: Retrofit buildings\nThis module contains an example that shows how to retrofit all buildings\nin a TEASER project with different setups\nYou can run this example using the [jupyter-notebook](https://mybinder.org/v2/gh/RWTH-EBC/TEASER/main?labpath=docs%2Fjupyter_notebooks)\n" }, { "cell_type": "code", diff --git a/docs/source/examples/e1_generate_archetype.md b/docs/source/examples/e1_generate_archetype.md index 8267f268d..efdacc4e9 100644 --- a/docs/source/examples/e1_generate_archetype.md +++ b/docs/source/examples/e1_generate_archetype.md @@ -2,7 +2,7 @@ # Example 1: Generate archetype buildings using TEASER API This module contains an example how to generate archetype buildings using TEASER API functions. -You can run this example using the [jupyter-notebook](https://mybinder.org/v2/gh/RWTH-EBC/TEASER/master?labpath=docs%2Fjupyter_notebooks) +You can run this example using the [jupyter-notebook](https://mybinder.org/v2/gh/RWTH-EBC/TEASER/main?labpath=docs%2Fjupyter_notebooks) First step: Import the TEASER API (called Project) into your Python module diff --git a/docs/source/examples/e2_export_aixlib_models.md b/docs/source/examples/e2_export_aixlib_models.md index 4c92490cd..b05643f89 100644 --- a/docs/source/examples/e2_export_aixlib_models.md +++ b/docs/source/examples/e2_export_aixlib_models.md @@ -5,7 +5,7 @@ This module contains an example how to export buildings from a TEASER project to ready-to-run simulation models for Modelica library AixLib. These models will only simulate using Dymola, the reason for this are state machines that are used in one AixLib specific AHU model. -You can run this example using the [jupyter-notebook](https://mybinder.org/v2/gh/RWTH-EBC/TEASER/master?labpath=docs%2Fjupyter_notebooks) +You can run this example using the [jupyter-notebook](https://mybinder.org/v2/gh/RWTH-EBC/TEASER/main?labpath=docs%2Fjupyter_notebooks) ```python import teaser.examples.e1_generate_archetype as e1 diff --git a/docs/source/examples/e3_export_ibpsa_models.md b/docs/source/examples/e3_export_ibpsa_models.md index 3a1e89755..8caf1b035 100644 --- a/docs/source/examples/e3_export_ibpsa_models.md +++ b/docs/source/examples/e3_export_ibpsa_models.md @@ -3,7 +3,7 @@ This module contains an example how to export buildings from a TEASER project to ready-to-run simulation models for Modelica library IBPSA. These models simulate in Dymola, OpenModelica and JModelica. -You can run this example using the [jupyter-notebook](https://mybinder.org/v2/gh/RWTH-EBC/TEASER/master?labpath=docs%2Fjupyter_notebooks) +You can run this example using the [jupyter-notebook](https://mybinder.org/v2/gh/RWTH-EBC/TEASER/main?labpath=docs%2Fjupyter_notebooks) ```python import teaser.examples.e1_generate_archetype as e1 diff --git a/docs/source/examples/e4_save.md b/docs/source/examples/e4_save.md index bb41ca514..4c06d7784 100644 --- a/docs/source/examples/e4_save.md +++ b/docs/source/examples/e4_save.md @@ -2,7 +2,7 @@ # Example 4: Save information This module contains an example how to save buildings from a TEASER project to json and pickle in order to save information. -You can run this example using the [jupyter-notebook](https://mybinder.org/v2/gh/RWTH-EBC/TEASER/master?labpath=docs%2Fjupyter_notebooks) +You can run this example using the [jupyter-notebook](https://mybinder.org/v2/gh/RWTH-EBC/TEASER/main?labpath=docs%2Fjupyter_notebooks) ```python import teaser.examples.e1_generate_archetype as e1 diff --git a/docs/source/examples/e5_load.md b/docs/source/examples/e5_load.md index 053c0f5ee..6d554f8c8 100644 --- a/docs/source/examples/e5_load.md +++ b/docs/source/examples/e5_load.md @@ -2,7 +2,7 @@ # Example 5: Load information This module contains an example how to import TEASER projects from `*.teaserjson` and pickle in order to reuse data. -You can run this example using the [jupyter-notebook](https://mybinder.org/v2/gh/RWTH-EBC/TEASER/master?labpath=docs%2Fjupyter_notebooks) +You can run this example using the [jupyter-notebook](https://mybinder.org/v2/gh/RWTH-EBC/TEASER/main?labpath=docs%2Fjupyter_notebooks) ```python import teaser.logic.utilities as utilities diff --git a/docs/source/examples/e6_generate_building.md b/docs/source/examples/e6_generate_building.md index ff562aa1a..27bde30d7 100644 --- a/docs/source/examples/e6_generate_building.md +++ b/docs/source/examples/e6_generate_building.md @@ -5,7 +5,7 @@ the archetype approach but adding all information separately. In this example we import all needed modules and classes where we need it in the code. For you application we suggest to use PEP008 and import them at the beginning of the script. -You can run this example using the [jupyter-notebook](https://mybinder.org/v2/gh/RWTH-EBC/TEASER/master?labpath=docs%2Fjupyter_notebooks) +You can run this example using the [jupyter-notebook](https://mybinder.org/v2/gh/RWTH-EBC/TEASER/main?labpath=docs%2Fjupyter_notebooks) First step: Import the TEASER API (called Project) into your Python module diff --git a/docs/source/examples/e7_retrofit.md b/docs/source/examples/e7_retrofit.md index 771892ec2..be5f96256 100644 --- a/docs/source/examples/e7_retrofit.md +++ b/docs/source/examples/e7_retrofit.md @@ -2,7 +2,7 @@ # Example 7: Retrofit buildings This module contains an example that shows how to retrofit all buildings in a TEASER project with different setups -You can run this example using the [jupyter-notebook](https://mybinder.org/v2/gh/RWTH-EBC/TEASER/master?labpath=docs%2Fjupyter_notebooks) +You can run this example using the [jupyter-notebook](https://mybinder.org/v2/gh/RWTH-EBC/TEASER/main?labpath=docs%2Fjupyter_notebooks) ```python import teaser.examples.e1_generate_archetype as e1