From b6df5a84b09e69b0c6939ace44a79022712a4519 Mon Sep 17 00:00:00 2001 From: F Rehmann <49240249+c0nb4@users.noreply.github.com> Date: Mon, 24 Feb 2025 14:09:48 +0100 Subject: [PATCH 1/2] Add: GitHub Templates --- .github/ISSUE_TEMPLATE/bug_report.md | 29 +++++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 20 ++++++++++++++++ .github/workflows/pylint.yml | 23 ++++++++++++++++++ 3 files changed, 72 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/workflows/pylint.yml diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..28ead53 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,29 @@ +--- +name: Bug report +about: Create a report to help us improve +title: '' +labels: '' +assignees: '' + +--- + +**Please describe the bug** +A clear and concise description of what the bug is. + +**What are the steps to reproduce the bug?** +1. Go to '...' +2. Click on '....' +3. Scroll down to '....' +4. See error + +**What behavior did you expect?** +A clear and concise description of what you expected to happen. + +**Can you add screenshots?** +If applicable, add screenshots to help explain your problem. + +**What environment are you using?** +Python version and installed packages + +**Additional context** +Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..bbcbbe7 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,20 @@ +--- +name: Feature request +about: Suggest an idea for this project +title: '' +labels: '' +assignees: '' + +--- + +**Is your feature request related to a problem? Please describe.** +A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + +**Describe the solution you'd like** +A clear and concise description of what you want to happen. + +**Describe alternatives you've considered** +A clear and concise description of any alternative solutions or features you've considered. + +**Additional context** +Add any other context or screenshots about the feature request here. diff --git a/.github/workflows/pylint.yml b/.github/workflows/pylint.yml new file mode 100644 index 0000000..cf34e6d --- /dev/null +++ b/.github/workflows/pylint.yml @@ -0,0 +1,23 @@ +name: Pylint + +on: [push] + +jobs: + build: + runs-on: ubuntu-latest + strategy: + matrix: + python-version: ["3.10"] + steps: + - uses: actions/checkout@v3 + - name: Set up Python ${{ matrix.python-version }} + uses: actions/setup-python@v3 + with: + python-version: ${{ matrix.python-version }} + - name: Install dependencies + run: | + python -m pip install --upgrade pip + pip install pylint + - name: Run pylint with verbose output + run: pylint --verbose . --output=lint.txt || true + From 24d102e4782e7e98dcdbace4bb68b09606514be5 Mon Sep 17 00:00:00 2001 From: F Rehmann <49240249+c0nb4@users.noreply.github.com> Date: Mon, 24 Feb 2025 14:14:22 +0100 Subject: [PATCH 2/2] Update: Readme --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 2922962..50ca914 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@ # TECDEM - Tool for Efficient CityGML District Energy Modelling -This is the Tool for Efficient CityGML District Energy Modelling (TECDEM). It is a Python-based tool that utilizes CityGML, the [EnergyADE](https://www.citygmlwiki.org/images/4/41/KIT-UML-Diagramme-Profil.pdf), and the [Districtgenerator](https://github.com/RWTH-EBC/districtgenerator) (also known as Quartiersgenerator) to easily parameterize districts based on CityGML files, extract and enrich data for simulation, and visualize the results. +This is the Tool for Efficient CityGML District Energy Modelling (TECDEM). It is a Python-based tool that utilizes CityGML, the [EnergyADE](https://www.citygmlwiki.org/images/4/41/KIT-UML-Diagramme-Profil.pdf), and the [DistrictGenerator](https://github.com/RWTH-EBC/districtgenerator) (also known as Quartiersgenerator) to easily parameterize districts based on CityGML files, extract and enrich data for simulation, and visualize the results. -TECDEM is a tool that can be used for quickly exraction geometry and further information for simulation of districts. We consider districts and tools for their modeling and simulation, as districts provide an important scale in the energy transition. They offer more flexibility than a single building and hence can be considered the smallest cell of energy transition. +TECDEM is a tool that can be used to extract geometry and further information for simulation of districts. We consider districts and tools for their modeling and simulation, as districts provide an important scale in the energy transition. They offer more flexibility than a single building and can be considered the smallest cell of energy transition. ## Project Status @@ -14,7 +14,7 @@ To install TECDEM, follow these steps: 1. Clone this repository 2. Run: `pip install -r requirements.txt` -3. Navigate to the `src` folder and clone this branch of the [Districtgenerator](https://github.com/c0nb4/districtgenerator) +3. Navigate to the `src` folder and clone this fork of the [DistrictGenerator](https://github.com/c0nb4/districtgenerator) . Install it accordingly. For a complete list of dependencies, please refer to the `requirements.txt` file in the repository. @@ -32,7 +32,7 @@ Please refer to the experiments in the repository for examples of how to use TEC TECDEM utilizes [CityDPC](https://github.com/RWTH-E3D/CityDPC) componenets for geometry extraction and further processing. The strucuture of the project is displayed in the following diagram: -Project Structure +![Project Structure](img/TECDEM_structure_v01.png) ## Roadmap @@ -60,7 +60,7 @@ At present, there are no other contributors to the project. However, we welcome TECDEM utilizes [CityDPC](https://github.com/RWTH-E3D/CityDPC) componenets for geometry extraction and further processing. -TECDEM utilizes [Districtgenerator](https://github.com/RWTH-EBC/districtgenerator) for the simulation of the districts. +TECDEM utilizes [DistrictGenerator](https://github.com/RWTH-EBC/districtgenerator) for the simulation of the districts, in a forked version: [DistrictGenerator](https://github.com/c0nb4/districtgenerator) TECDEM utilizes [TABULA](https://www.iwu.de/index.php?id=205) for archetype enrichment of residential buildings.