From f68b1b173e191c8e4f200e26b2fc6bcac137368f Mon Sep 17 00:00:00 2001 From: "fabian.wuellhorst" Date: Fri, 15 Nov 2024 10:25:03 +0100 Subject: [PATCH] Rename master to main, also in code --- .github/workflows/codeql-analysis.yml | 4 ++-- .gitlab-ci.yml | 2 +- README.md | 14 +++++++------- docs/source/Literatur.bib | 2 +- docs/source/conf.py | 2 +- docs/source/development.rst | 2 +- docs/source/index.rst | 6 +++--- teaser/examples/e1_generate_archetype.py | 2 +- teaser/examples/e2_export_aixlib_models.py | 2 +- teaser/examples/e3_export_ibpsa_models.py | 2 +- teaser/examples/e4_save.py | 2 +- teaser/examples/e5_load.py | 2 +- teaser/examples/e6_generate_building.py | 2 +- teaser/examples/e7_retrofit.py | 2 +- teaser/logic/buildingobjects/calculation/aixlib.py | 2 +- 15 files changed, 24 insertions(+), 24 deletions(-) diff --git a/.github/workflows/codeql-analysis.yml b/.github/workflows/codeql-analysis.yml index deaee4647..02b929618 100644 --- 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 index b1fb3d0e4..a20ef2e14 100644 --- 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 index 1bfbe1691..a88693e01 100644 --- 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 [ebc-teaser@eonerc.rwth-aachen.de](mailto:ebc-teaser@eonerc.rwth-aachen.de). @@ -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/source/Literatur.bib b/docs/source/Literatur.bib index f8271f1db..d83b5ffbf 100644 --- a/docs/source/Literatur.bib +++ b/docs/source/Literatur.bib @@ -336,7 +336,7 @@ @book{.20012001 isbn = {9783441921639} } -@mastersthesis{Mehrfeld.2014, +@mainsthesis{Mehrfeld.2014, type = {Masterarbeit}, author = {Mehrfeld, Philipp}, school = {Lehrstuhl f{\"u}r Geb{\"a}ude- und Raumklimatechnik, RWTH Aachen}, diff --git a/docs/source/conf.py b/docs/source/conf.py index e12256e48..6490ff86a 100644 --- 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 index f2df6646e..92a0014be 100644 --- 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/index.rst b/docs/source/index.rst index 0c0f76dda..928d635fb 100644 --- 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 `_. 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 `_ Also have a look at the `FAQ section `_. If you feel your question should also be listed, please open an issue in the issue section of the `repository `_. @@ -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 `__, `bibtex `__ - - 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 `__, `bibtex `__ + - 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 `__, `bibtex `__ + - 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 `__, `bibtex `__ - 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 `__ Funding diff --git a/teaser/examples/e1_generate_archetype.py b/teaser/examples/e1_generate_archetype.py index 32d551e5d..9c823d328 100644 --- 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 index 39a07f8a2..898cc394d 100644 --- 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 index 76f0825a2..3c3592f41 100644 --- 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 diff --git a/teaser/examples/e4_save.py b/teaser/examples/e4_save.py index 2415a6fd1..f0244671b 100644 --- a/teaser/examples/e4_save.py +++ b/teaser/examples/e4_save.py @@ -1,7 +1,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) import teaser.examples.e1_generate_archetype as e1 diff --git a/teaser/examples/e5_load.py b/teaser/examples/e5_load.py index 361a4e459..5c12f84a8 100644 --- a/teaser/examples/e5_load.py +++ b/teaser/examples/e5_load.py @@ -1,7 +1,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) import teaser.logic.utilities as utilities diff --git a/teaser/examples/e6_generate_building.py b/teaser/examples/e6_generate_building.py index 1e6d577f2..895b2e676 100644 --- a/teaser/examples/e6_generate_building.py +++ b/teaser/examples/e6_generate_building.py @@ -4,7 +4,7 @@ # 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) diff --git a/teaser/examples/e7_retrofit.py b/teaser/examples/e7_retrofit.py index b33acfb7c..a5be9fba3 100644 --- a/teaser/examples/e7_retrofit.py +++ b/teaser/examples/e7_retrofit.py @@ -1,7 +1,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) import teaser.examples.e1_generate_archetype as e1 diff --git a/teaser/logic/buildingobjects/calculation/aixlib.py b/teaser/logic/buildingobjects/calculation/aixlib.py index ecc888d10..e7c24e6f0 100644 --- a/teaser/logic/buildingobjects/calculation/aixlib.py +++ b/teaser/logic/buildingobjects/calculation/aixlib.py @@ -30,7 +30,7 @@ class AixLib(object): file_internal_gains : str Filename for internal gains file version : str - Used AixLib version, default should always be current master version + Used AixLib version, default should always be current main version of GitHub total_surface_area : float [m2] This is the total surface area of the building for interior and