Merge pull request #783 from RWTH-EBC/masterToMain

Rename master to main, also in code
RWTH-EBC · Nov 15, 2024 · e32ccdb · e32ccdb
2 parents 68767c2 + c600ab7
commit e32ccdb
Show file tree

Hide file tree

Showing 28 changed files with 37 additions and 37 deletions.
diff --git a/.github/workflows/codeql-analysis.yml b/.github/workflows/codeql-analysis.yml
@@ -7,10 +7,10 @@ name: "CodeQL"
 
 on:
   push:
-    branches: [master, development]
+    branches: [main]
   pull_request:
     # The branches below must be a subset of the branches above
-    branches: [master]
+    branches: [main]
   schedule:
     - cron: '0 2 * * 1-5'
 

diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml
@@ -9,7 +9,7 @@ stages:
 
 variables:
   COVERAGE_TYPE: "NotDymola"
-  PAGES_BRANCH: master
+  PAGES_BRANCH: main
   PYTHON_VERSION: "registry.git.rwth-aachen.de/ebc/ebc_all/gitlab_ci/templates:python_3.9"
   PYTHON_PACKAGE_NAME: "teaser"
   TEST_ENGINE: "PYTEST"

diff --git a/README.md b/README.md
@@ -4,8 +4,8 @@
 
 [![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)
+[![Build Status](https://travis-ci.org/RWTH-EBC/TEASER.svg?branch=main)](https://travis-ci.org/RWTH-EBC/TEASER.svg?branch=main)
+[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/RWTH-EBC/TEASER/main?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
@@ -28,7 +28,7 @@ classes and functions can be found at the website:
 
 This GitHub page will be used to further develop the package and make it
 available under the
-[MIT License](https://github.com/RWTH-EBC/TEASER/blob/master/License.md).
+[MIT License](https://github.com/RWTH-EBC/TEASER/blob/main/License.md).
 
 If you have any questions regarding TEASER feel free to contact us at
 [[email protected]](mailto:[email protected]).
@@ -113,14 +113,14 @@ The workflow for changes is described in our [Wiki](https://github.com/RWTH-EBC/
 
 + TEASER: an open tool for urban energy modelling of building stocks. Remmen P., Lauster M., Mans M., Fuchs M., Osterhage T., Müller D.. Journal of Building Performance Simulation, February 2017,
 [pdf](http://dx.doi.org/10.1080/19401493.2017.1283539),
-[bibtex](https://github.com/RWTH-EBC/TEASER/tree/master/doc/cite_jbps.bib)
+[bibtex](https://github.com/RWTH-EBC/TEASER/tree/main/doc/cite_jbps.bib)
 
 ### TEASER related publications
 
 + CityGML Import and Export for Dynamic Building Performance Simulation in Modelica. Remmen P.,
 Lauster M., Mans M., Osterhage T., Müller D.. BSO16, p.329-336, September 2016,
 [pdf](http://www.ibpsa.org/proceedings/BSO2016/p1047.pdf),
-[bibtex](https://github.com/RWTH-EBC/TEASER/tree/master/doc/cite.bib)
+[bibtex](https://github.com/RWTH-EBC/TEASER/tree/main/doc/cite.bib)
 
 + Scalable Design-Driven Parameterization of Reduced Order Models Using Archetype Buildings with TEASER.
 Lauster M., Mans M., Remmen P., Fuchs M., Müller D.. BauSIM2016, p.535-542, September 2016,
@@ -130,7 +130,7 @@ Lauster M., Mans M., Remmen P., Fuchs M., Müller D.. BauSIM2016, p.535-542, Sep
 Remmen P., Schäfer J., Müller D.. Building Simulation 2019, September 2019,
 [pdf](https://www.researchgate.net/publication/337925776_Refinement_of_Dynamic_Non-Residential_Building_Archetypes_Using_Measurement_Data_and_Bayesian_Calibration)
 
-+ Selecting statistical indices for calibrating building energy models. Vogt, M., Remmen P., Lauster M., Fuchs M. , Müller D.. Building and Environment 144, pages 94-107, October 2018. [bibtex](https://github.com/RWTH-EBC/TEASER/tree/master/doc/cite_be.bib)
++ Selecting statistical indices for calibrating building energy models. Vogt, M., Remmen P., Lauster M., Fuchs M. , Müller D.. Building and Environment 144, pages 94-107, October 2018. [bibtex](https://github.com/RWTH-EBC/TEASER/tree/main/doc/cite_be.bib)
 
 + The [Institute of Energy Efficiency and Sustainable Building](https://www.e3d.rwth-aachen.de/go/id/iyld/?) published a parametric study of TEASER where all functions and  parameters used in TEASER are gathered and explained. The publication can be found [here](https://publications.rwth-aachen.de/record/749801/files/749801.pdf).
 
@@ -140,7 +140,7 @@ Remmen P., Schäfer J., Müller D.. Building Simulation 2019, September 2019,
 TEASER is released by RWTH Aachen University, E.ON Energy
 Research Center, Institute for Energy Efficient Buildings and Indoor Climate,
 under the
-[MIT License](https://github.com/RWTH-EBC/TEASER/blob/master/License.md).
+[MIT License](https://github.com/RWTH-EBC/TEASER/blob/main/License.md).
 
 ## Acknowledgements
 

diff --git 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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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/conf.py b/docs/source/conf.py
@@ -57,7 +57,7 @@
 # The encoding of source files.
 # source_encoding = 'utf-8-sig'
 
-# The master toctree document.
+# The main toctree document.
 master_doc = "index"
 
 # General information about the project.

diff --git a/docs/source/development.rst b/docs/source/development.rst
@@ -2,7 +2,7 @@ Issues solved in development
 =============================
 
 Issues that are solved and implemented in development, but not available in
-master branch:
+main branch:
 
    - Export for individual libraries instead of IBPSA library https://github.com/RWTH-EBC/TEASER/issues/440
    - New FAQ section in the documentation https://github.com/RWTH-EBC/TEASER/issues/442
diff --git 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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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

diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -35,7 +35,7 @@ If you have any questions regarding TEASER feel free to contact us at
 Note that this documentation will always be auto-generated using the
 `development branch <https://github.com/RWTH-EBC/TEASER/tree/development>`_.
 That means, there might be new developments described in this docu that are not
-working in the master and pip installation of TEASER. A list of those issue can
+working in the main and pip installation of TEASER. A list of those issue can
 be found `here <development.html>`_
 
 Also have a look at the `FAQ section <faq.html>`_. If you feel your question should also be listed, please open an issue in the issue section of the `repository <https://github.com/RWTH-EBC/TEASER/issues>`_.
@@ -59,8 +59,8 @@ Contents
 
 Publications
 ============
-  - TEASER: an open tool for urban energy modelling of building stocks. Remmen P., Lauster M., Mans M., Fuchs M., Osterhage T., Müller D.. Journal of Building Performance Simulation, February 2017, `pdf <http://dx.doi.org/10.1080/19401493.2017.1283539>`__, `bibtex <https://github.com/RWTH-EBC/TEASER/tree/master/doc/cite_jbps.bib>`__
-  - CityGML Import and Export for Dynamic Building Performance Simulation in Modelica. Remmen P., Lauster M., Mans M., Osterhage T., Müller D.. BSO16, p.329-336, September 2016, `pdf <http://www.ibpsa.org/proceedings/BSO2016/p1047.pdf>`__, `bibtex <https://github.com/RWTH-EBC/TEASER/tree/master/doc/cite.bib>`__
+  - TEASER: an open tool for urban energy modelling of building stocks. Remmen P., Lauster M., Mans M., Fuchs M., Osterhage T., Müller D.. Journal of Building Performance Simulation, February 2017, `pdf <http://dx.doi.org/10.1080/19401493.2017.1283539>`__, `bibtex <https://github.com/RWTH-EBC/TEASER/tree/main/doc/cite_jbps.bib>`__
+  - CityGML Import and Export for Dynamic Building Performance Simulation in Modelica. Remmen P., Lauster M., Mans M., Osterhage T., Müller D.. BSO16, p.329-336, September 2016, `pdf <http://www.ibpsa.org/proceedings/BSO2016/p1047.pdf>`__, `bibtex <https://github.com/RWTH-EBC/TEASER/tree/main/doc/cite.bib>`__
   - Scalable Design-Driven Parameterization of Reduced Order Models Using Archetype Buildings with TEASER. Lauster M., Mans M., Remmen P., Fuchs M., Müller D.. BauSIM2016, p.535-542, September 2016, `pdf <https://www.researchgate.net/profile/Moritz_Lauster/publication/310465372_Scalable_Design-Driven_Parameterization_of_Reduced_Order_Models_using_Archetype_Buildings_with_TEASER/links/582ee96908ae004f74be1fb0.pdf?origin=publication_detail&ev=pub_int_prw_xdl&msrp=eEyK6WYemhC8wK7xkMEPRDO4obE4uxBN4-0BdBy1Ldwhy9FhCe1pXfNObJYubvC_aZN0IWDPf9uayBo3u79bsZvg3hzUoLoYRatES2ARH8c.B2cYwSICt0IOa7lD-4oAiEa_3TtrO-7k-1W9chuNQwr_VNMCpZ5ubSb-eY2D77rGUP4S6wS8m6vudUUbMlXbQQ.Cledgd1Q9fPp11nYGpcpKNhSS6bVTqAEXeMZPkiV3HsJxcVWTFj4Hr_jmLZ0MOzDxbDEZObcGiKfmTL_9k_59A>`__
 
 Funding

diff --git a/teaser/examples/e1_generate_archetype.py b/teaser/examples/e1_generate_archetype.py
@@ -1,7 +1,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)
 
 
 def example_generate_archetype():

diff --git a/teaser/examples/e2_export_aixlib_models.py b/teaser/examples/e2_export_aixlib_models.py
@@ -4,7 +4,7 @@
 # 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)
 
 import teaser.examples.e1_generate_archetype as e1
 import teaser.logic.utilities as utilities

diff --git a/teaser/examples/e3_export_ibpsa_models.py b/teaser/examples/e3_export_ibpsa_models.py
@@ -2,7 +2,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)
 
 import teaser.examples.e1_generate_archetype as e1
 import teaser.logic.utilities as utilities