Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rename master to main, also in code #783

Merged
merged 3 commits into from
Nov 15, 2024
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .github/workflows/codeql-analysis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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'

Expand Down
2 changes: 1 addition & 1 deletion .gitlab-ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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]).
Expand Down Expand Up @@ -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,
Expand All @@ -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).

Expand All @@ -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

Expand Down
2 changes: 1 addition & 1 deletion docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion docs/source/development.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
6 changes: 3 additions & 3 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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>`_.
Expand All @@ -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
Expand Down
2 changes: 1 addition & 1 deletion teaser/examples/e1_generate_archetype.py
Original file line number Diff line number Diff line change
@@ -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():
Expand Down
2 changes: 1 addition & 1 deletion teaser/examples/e2_export_aixlib_models.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion teaser/examples/e3_export_ibpsa_models.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion teaser/examples/e4_save.py
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion teaser/examples/e5_load.py
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion teaser/examples/e6_generate_building.py
Original file line number Diff line number Diff line change
Expand Up @@ -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)



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

Expand Down
2 changes: 1 addition & 1 deletion teaser/logic/buildingobjects/calculation/aixlib.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Loading