Skip to content

Commit

Permalink
Merge pull request #740 from RWTH-EBC/try_gh_app [PYPI-RELEASE]
Browse files Browse the repository at this point in the history 
Add docs and correct pypi-release [PYPI-RELEASE]
  • Loading branch information
@FWuellhorst
FWuellhorst authored Sep 14, 2023
2 parents 134c712 + 1c70f95 commit 4120e6a
Show file tree
Hide file tree
Showing 96 changed files with 968 additions and 1,206 deletions.
1 change: 1 addition & 0 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
[![License](http://img.shields.io/:license-mit-blue.svg)](http://doge.mit-license.org)
[![Coverage Status](https://coveralls.io/repos/github/RWTH-EBC/TEASER/badge.svg)](https://coveralls.io/github/RWTH-EBC/TEASER)
[![Build Status](https://travis-ci.org/RWTH-EBC/TEASER.svg?branch=master)](https://travis-ci.org/RWTH-EBC/TEASER.svg?branch=master)
[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/RWTH-EBC/TEASER/master?labpath=docs%2Fjupyter_notebooks)

TEASER (Tool for Energy Analysis and Simulation for Efficient Retrofit) allows
fast generation of archetype buildings with low input requirements and the
Expand Down
23 changes: 8 additions & 15 deletions docs/jupyter_notebooks/e1_generate_archetype.ipynb
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,19 +3,12 @@
{
"cell_type": "markdown",
"metadata": {},
"source": " Created July 2015\n TEASER 4 Development Team\n"
},
{
"cell_type": "code",
"execution_count": null,
"metadata": {},
"outputs": [],
"source": "\"\"\"This module contains an example how to generate archetype buildings using\nTEASER API functions.\n\"\"\"\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/master?labpath=docs%2Fjupyter_notebooks)\n"
},
{
"cell_type": "markdown",
"metadata": {},
"source": " First step: Import the TEASER API (called Project) into your Python\n module\n"
"source": "First step: Import the TEASER API (called Project) into your Python\nmodule\n"
},
{
"cell_type": "code",
Expand All @@ -27,7 +20,7 @@
{
"cell_type": "markdown",
"metadata": {},
"source": " To use the API instantiate the Project class and rename the Project. The\n parameter load_data=True indicates that we load `iwu` typology archetype\n data into our Project (e.g. for Material properties and typical wall\n constructions. This can take a few seconds, depending on the size of the\n used data base). Be careful: Dymola does not like whitespaces in names and\n filenames, thus we will delete them anyway in TEASER.\n"
"source": "To use the API instantiate the Project class and rename the Project. The\nparameter load_data=True indicates that we load `iwu` typology archetype\ndata into our Project (e.g. for Material properties and typical wall\nconstructions. This can take a few seconds, depending on the size of the\nused data base). Be careful: Dymola does not like whitespaces in names and\nfilenames, thus we will delete them anyway in TEASER.\n"
},
{
"cell_type": "code",
Expand All @@ -39,12 +32,12 @@
{
"cell_type": "markdown",
"metadata": {},
"source": " There are two different types of archetype groups: residential and\n non-residential buildings. Two API functions offer the opportunity to\n generate specific archetypes.\n"
"source": "There are two different types of archetype groups: residential and\nnon-residential buildings. Two API functions offer the opportunity to\ngenerate specific archetypes.\n"
},
{
"cell_type": "markdown",
"metadata": {},
"source": " To generate residential archetype buildings the function\n Project.add_residential() is used. Seven parameters are compulsory,\n additional parameters can be set according to the used method. `method`\n and `usage` are used to distinguish between different archetype\n methods. The name, year_of_construction, number and height of floors\n and net_leased_area need to be set to provide enough information for\n archetype generation. For specific information on the parameters please\n read the docs.\n"
"source": "To generate residential archetype buildings the function\nProject.add_residential() is used. Seven parameters are compulsory,\nadditional parameters can be set according to the used method. `method`\nand `usage` are used to distinguish between different archetype\nmethods. The name, year_of_construction, number and height of floors\nand net_leased_area need to be set to provide enough information for\narchetype generation. For specific information on the parameters please\nread the docs.\n"
},
{
"cell_type": "code",
Expand All @@ -56,7 +49,7 @@
{
"cell_type": "markdown",
"metadata": {},
"source": " To generate non-residential archetype buildings (in this case an\n office and a laboratory (a.k.a. institute)) the function\n Project.add_residential() is used. The meaning of compulsory parameters\n does not differ from the residential archetype building.\n"
"source": "To generate non-residential archetype buildings (in this case an\noffice and a laboratory (a.k.a. institute)) the function\nProject.add_residential() is used. The meaning of compulsory parameters\ndoes not differ from the residential archetype building.\n"
},
{
"cell_type": "code",
Expand All @@ -68,12 +61,12 @@
{
"cell_type": "markdown",
"metadata": {},
"source": " Besides `iwu` and `bmvbs` there is a third option for archetype\n generation. We integrated the typology of TABULA Germany\n (http://webtool.building-typology.eu/#bm) and other countries are about to\n follow. To use TABULA archetype simple choose `tabula_de` as the method\n and `single_family_house`, `multi_family_house`, `terraced_house` or\n `apartment_block` as the usage. In addition you can specify the\n construction type of TABULA, chose between `tabula_standard` (default),\n `tabula_retrofit` or `tabula_adv_retrofit`. In this case we generate one\n single and one multi family house with TABULA typology.\n"
"source": "Besides `iwu` and `bmvbs` there is a third option for archetype\ngeneration. We integrated the typology of TABULA Germany\n(http://webtool.building-typology.eu/#bm) and other countries are about to\nfollow. To use TABULA archetype simple choose `tabula_de` as the method\nand `single_family_house`, `multi_family_house`, `terraced_house` or\n`apartment_block` as the usage. In addition you can specify the\nconstruction type of TABULA, chose between `tabula_standard` (default),\n`tabula_retrofit` or `tabula_adv_retrofit`. In this case we generate one\nsingle and one multi family house with TABULA typology.\n"
},
{
"cell_type": "markdown",
"metadata": {},
"source": " Please not: as we need to load the construction information which are\n rather big for TABULA, switching from one typology to another in the same\n Project takes some seconds. If you know from beginning you will only use\n TABULA typology you should instantiate you Project class without loading\n data. Project(load_data=False).\n"
"source": "Please not: as we need to load the construction information which are\nrather big for TABULA, switching from one typology to another in the same\nProject takes some seconds. If you know from beginning you will only use\nTABULA typology you should instantiate you Project class without loading\ndata. Project(load_data=False).\n"
},
{
"cell_type": "code",
Expand Down
19 changes: 12 additions & 7 deletions docs/jupyter_notebooks/e2_export_aixlib_models.ipynb
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,19 +3,24 @@
{
"cell_type": "markdown",
"metadata": {},
"source": " Created January 2017\n TEASER Development Team\n"
"source": "# Example 2: Export Modelica models for AixLib library using TEASER API\n"
},
{
"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"
},
{
"cell_type": "code",
"execution_count": null,
"metadata": {},
"outputs": [],
"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.\n\"\"\"\n\nimport teaser.examples.e1_generate_archetype as e1\nimport teaser.logic.utilities as utilities\nimport os\n"
"source": "import teaser.examples.e1_generate_archetype as e1\nimport teaser.logic.utilities as utilities\nimport os\n"
},
{
"cell_type": "markdown",
"metadata": {},
"source": " In e1_generate_archetype we created a Project with three archetype\n buildings to get this Project we rerun this example\n"
"source": "In e1_generate_archetype we created a Project with three archetype\nbuildings to get this Project we rerun this example\n"
},
{
"cell_type": "code",
Expand All @@ -27,12 +32,12 @@
{
"cell_type": "markdown",
"metadata": {},
"source": " To make sure the export is using the desired parameters you should\n always set model settings in the Project.\n Project().used_library_calc specifies the used Modelica library\n Project().number_of_elements_calc sets the models order\n For more information on models we'd like to refer you to the docs. By\n default TEASER uses a weather file provided in\n teaser.data.input.inputdata.weatherdata. You can use your own weather\n file by setting Project().weather_file_path. However we will use default\n weather file.\n Be careful: Dymola does not like whitespaces in names and filenames,\n thus we will delete them anyway in TEASER.\n"
"source": "To make sure the export is using the desired parameters you should\nalways set model settings in the Project.\nProject().used_library_calc specifies the used Modelica library\nProject().number_of_elements_calc sets the models order\nFor more information on models we'd like to refer you to the docs. By\ndefault TEASER uses a weather file provided in\nteaser.data.input.inputdata.weatherdata. You can use your own weather\nfile by setting Project().weather_file_path. However we will use default\nweather file.\nBe careful: Dymola does not like whitespaces in names and filenames,\nthus we will delete them anyway in TEASER.\n"
},
{
"cell_type": "markdown",
"metadata": {},
"source": " for CI testing purpose we set the reference result folder\n"
"source": "for CI testing purpose we set the reference result folder\n"
},
{
"cell_type": "code",
Expand All @@ -44,7 +49,7 @@
{
"cell_type": "markdown",
"metadata": {},
"source": " To make sure the parameters are calculated correctly we recommend to\n run calc_all_buildings() function\n"
"source": "To make sure the parameters are calculated correctly we recommend to\nrun calc_all_buildings() function\n"
},
{
"cell_type": "code",
Expand All @@ -56,7 +61,7 @@
{
"cell_type": "markdown",
"metadata": {},
"source": " To export the ready-to-run models simply call Project.export_aixlib().\n You can specify the path, where the model files should be saved.\n None means, that the default path in your home directory\n will be used. If you only want to export one specific building, you can\n pass over the internal_id of that building and only this model will be\n exported. In this case we want to export all buildings to our home\n directory, thus we are passing over None for both parameters.\n"
"source": "To export the ready-to-run models simply call Project.export_aixlib().\nYou can specify the path, where the model files should be saved.\nNone means, that the default path in your home directory\nwill be used. If you only want to export one specific building, you can\npass over the internal_id of that building and only this model will be\nexported. In this case we want to export all buildings to our home\ndirectory, thus we are passing over None for both parameters.\n"
},
{
"cell_type": "code",
Expand Down
12 changes: 6 additions & 6 deletions docs/jupyter_notebooks/e3_export_ibpsa_models.ipynb
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,19 +3,19 @@
{
"cell_type": "markdown",
"metadata": {},
"source": " Created January 2017\n TEASER Development Team\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/master?labpath=docs%2Fjupyter_notebooks)\n"
},
{
"cell_type": "code",
"execution_count": null,
"metadata": {},
"outputs": [],
"source": "\"\"\"This 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.\n\"\"\"\n\nimport teaser.examples.e1_generate_archetype as e1\nimport teaser.logic.utilities as utilities\nimport os\n"
"source": "import teaser.examples.e1_generate_archetype as e1\nimport teaser.logic.utilities as utilities\nimport os\n"
},
{
"cell_type": "markdown",
"metadata": {},
"source": " In e1_generate_archetype we created a Project with three archetype\n buildings to get this Project we rerun this example\n"
"source": "In e1_generate_archetype we created a Project with three archetype\nbuildings to get this Project we rerun this example\n"
},
{
"cell_type": "code",
Expand All @@ -27,7 +27,7 @@
{
"cell_type": "markdown",
"metadata": {},
"source": " To make sure the export is using the desired parameters you should\n always set model settings in the Project.\n Project().used_library_calc specifies the used Modelica library\n Project().number_of_elements_calc sets the models order\n Project().merge_windows_calc specifies if thermal conduction through\n windows is lumped into outer walls or not.\n For more information on models we'd like to refer you to the docs. By\n default TEASER uses a weather file provided in\n teaser.data.input.inputdata.weatherdata. You can use your own weather\n file by setting Project().weather_file_path. However we will use default\n weather file.\n"
"source": "To make sure the export is using the desired parameters you should\nalways set model settings in the Project.\nProject().used_library_calc specifies the used Modelica library\nProject().number_of_elements_calc sets the models order\nProject().merge_windows_calc specifies if thermal conduction through\nwindows is lumped into outer walls or not.\nFor more information on models we'd like to refer you to the docs. By\ndefault TEASER uses a weather file provided in\nteaser.data.input.inputdata.weatherdata. You can use your own weather\nfile by setting Project().weather_file_path. However we will use default\nweather file.\n"
},
{
"cell_type": "code",
Expand All @@ -39,7 +39,7 @@
{
"cell_type": "markdown",
"metadata": {},
"source": " To make sure the parameters are calculated correctly we recommend to\n run calc_all_buildings() function\n"
"source": "To make sure the parameters are calculated correctly we recommend to\nrun calc_all_buildings() function\n"
},
{
"cell_type": "code",
Expand All @@ -51,7 +51,7 @@
{
"cell_type": "markdown",
"metadata": {},
"source": " To export the ready-to-run models simply call Project.export_ibpsa().\n First specify the IBPSA related library you want to export the models\n for. The models are identical in each library, but IBPSA Modelica\n library is just a core set of models and should not be used\n standalone. Valid values are 'AixLib' (default), 'Buildings',\n 'BuildingSystems' and 'IDEAS'. We chose AixLib\n You can specify the path, where the model files should be saved.\n None means, that the default path in your home directory\n will be used. If you only want to export one specific building, you can\n pass over the internal_id of that building and only this model will be\n exported. In this case we want to export all buildings to our home\n directory, thus we are passing over None for both parameters.\n"
"source": "To export the ready-to-run models simply call Project.export_ibpsa().\nFirst specify the IBPSA related library you want to export the models\nfor. The models are identical in each library, but IBPSA Modelica\nlibrary is just a core set of models and should not be used\nstandalone. Valid values are 'AixLib' (default), 'Buildings',\n'BuildingSystems' and 'IDEAS'. We chose AixLib\nYou can specify the path, where the model files should be saved.\nNone means, that the default path in your home directory\nwill be used. If you only want to export one specific building, you can\npass over the internal_id of that building and only this model will be\nexported. In this case we want to export all buildings to our home\ndirectory, thus we are passing over None for both parameters.\n"
},
{
"cell_type": "code",
Expand Down
Loading

0 comments on commit 4120e6a

Please sign in to comment.