Skip to content

Commit

Permalink
chore(examples): Automatic commit of example files in Markdown and Ju…
Browse files Browse the repository at this point in the history
…pyter Notebook format.
  • Loading branch information
[email protected] authored and [email protected] committed Nov 15, 2024
1 parent e286743 commit c600ab7
Show file tree
Hide file tree
Showing 14 changed files with 14 additions and 14 deletions.
2 changes: 1 addition & 1 deletion docs/jupyter_notebooks/e1_generate_archetype.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down
2 changes: 1 addition & 1 deletion docs/jupyter_notebooks/e2_export_aixlib_models.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down
2 changes: 1 addition & 1 deletion docs/jupyter_notebooks/e3_export_ibpsa_models.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down
2 changes: 1 addition & 1 deletion docs/jupyter_notebooks/e4_save.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down
2 changes: 1 addition & 1 deletion docs/jupyter_notebooks/e5_load.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down
2 changes: 1 addition & 1 deletion docs/jupyter_notebooks/e6_generate_building.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down
2 changes: 1 addition & 1 deletion docs/jupyter_notebooks/e7_retrofit.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down
2 changes: 1 addition & 1 deletion docs/source/examples/e1_generate_archetype.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/source/examples/e2_export_aixlib_models.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/source/examples/e3_export_ibpsa_models.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/source/examples/e4_save.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/source/examples/e5_load.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/source/examples/e6_generate_building.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion docs/source/examples/e7_retrofit.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit c600ab7

Please sign in to comment.