# Building Simulation CLI
This Python program provides a command-line interface (CLI) for simulating buildings based on data provided in a CSV or
Excel file. The program offers two main commands (`simulate_one_building` and `simulate_all_building`) to simulate
individual buildings or multiple buildings simultaneously.
## Prerequisites
Before running this program, ensure you have Python 3.10 or higher installed on your system. If Python is not already
installed, you can download and install it from the official website: [Python.org](https://www.python.org/downloads/)
### Installing Python
1. Visit the [Python Downloads](https://www.python.org/downloads/) page.
2. Choose the version appropriate for your operating system (Windows, macOS, or Linux) and click on the download link.
3. Run the installer and follow the installation instructions.
4. During the installation process, make sure to check the box that says "Add Python to PATH" or "Add Python to
environment variables" to ensure Python is added to your system PATH.
5. Once the installation is complete, open a command prompt or terminal and type `python --version` to verify that
Python is installed correctly.
#### Usage
To execute the CLI, use the provided Python script `dibs_cli.py`. The program expects the path to the file containing
building data as the first argument. The remaining four arguments are optional and have default values. If the user only
provides the path argument, the program will use default values for the other arguments. If the user provides all five
arguments, the program will simulate using the user's input.
### Command `simulate_one_building`
The `simulate_one` command performs the simulation for a single building. The building data must be provided as a CSV or
Excel file and contain only one record.
### Command `simulate_all_building`
The `simulate_all` command performs the simulation for multiple buildings. The building data must be provided as a CSV
or Excel file and contain multiple records. Each record must match the same pattern and have the same number of
attributes as a building object.
### Arguments:
- `path`: Path to the file containing building data type of `str`. (Required)
- `profile_from_norm`: type of `str`. (Optional)
- `gains_from_group_values`: type of `str`. (Optional)
- `usage_from_norm`: type of `str`. (Optional)
- `weather_period`: type of `str`. (Optional)
### CSV File Format Requirements:
- The CSV or Excel file must contain a specific number of columns.
- The column names in the CSV or Excel file must match the attributes of the building object to be simulated.
#### Example Building Object:
Suppose we have a `Building` object with the following attributes:
Corresponding CSV or Excel File Columns:
To simulate this Building object, the CSV or Excel file must have the following columns:
- `scr_gebaeude_id`: Building Screening-ID.
- `plz`: Zipcode of building's location in Germany.
- `hk_geb`: Usage type (main category)
- `uk_geb`: Usage type (subcategory)
- `max_occupancy`: Max. number of building occupants at any given time
- `wall_area_og`: Area of all walls above ground in contact with the outside [m2]
- `wall_area_ug`: Area of all walls below ground in contact with soil [m2]
- `window_area_north`: Area of the glazed surface in contact with the outside facing north [m2]
- `window_area_east`: Area of the glazed surface in contact with the outside facing east [m2]
- `window_area_south`: Area of the glazed surface in contact with the outside facing south [m2]
- `window_area_west`: Area of the glazed surface in contact with the outside facing west [m2]
- `roof_area`: Area of the roof in contact with the outside [m2]
- `net_room_area`: Area of all floor areas from usable rooms including all floor plan levels of the building (Refers
to "Netto-Raumfläche", DIN 277-1:2016-01) [m2]
- `energy_ref_area`: Energy reference area of the building [m2]
- `base_area`: Area for the calculation of transmission heat losses to the soil. Also used to calculate the building's
volume. [m2]
- `gross_base_area`: Gross base area of the building gross_base_area = base_area / 0.87 (currently unused)
- `building_height`: Mean height of the building [m]
- `net_volume`: Thermally conditioned net volum of building (air filled space within the building) (currently unused) [m3]
- `gross_volume`: Thermally conditioned gross volum of building (air filled space within the building) (currently unused) [m3]
- `envelope_area`: Total area of building envelope (currently unused) [m2]
- `lighting_load`: Lighting Load [W/m2]
- `lighting_control`: Lux threshold at which the lights turn on [Lx]
- `lighting_utilisation_factor`: A factor that determines how much natural solar lumminace is effectively utilised in
the space
- `lighting_maintenance_factor`: A factor based on how dirty the windows area
- `aw_construction`: Exterior wall construction type (currently unused)
- `shading_device`: Type of shading device for transparent surfaces including windows (currently ununsed)
- `shading_solar_transmittance`: Shading transmittance reduction factor for solar gains (currently ununsed)
- `glass_solar_transmittance`: Solar radiation passing through the window (g-value)
- `glass_solar_shading_transmittance`: Solar radiation passing through the window with active shading devices
- `glass_light_transmittance`: Solar illuminance passing through the window
- `u_windows`: U value of glazed and/or transparent surfaces [W/m2K]
- `u_walls`: U value of external walls [W/m2K]
- `u_roof`: U value of the roof [W/m2K]
- `u_base`: U value of the floor [W/m2K]
- `temp_adj_base`: Temperature adjustment factor for the floor
- `temp_adj_walls_ug`: Temperature adjustment factor for walls below ground
- `ach_inf`: Air changes per hour through infiltration [Air Changes Per Hour]
- `ach_win`: Air changes per hour through opened windows [Air Changes Per Hour]
- `ach_vent`: Air changes per hour through ventilation [Air Changes Per Hour]
- `heat_recovery_efficiency`: Efficiency of heat recovery
- `thermal_capacitance`: Thermal capacitance of the building [J/m2K]
- `t_set_heating`: Thermal heating set point [C]
- `t_start`: Indoor air temperatur for first time step of the simulation [C]
- `t_set_cooling`: Thermal cooling set point [C]
- `night_flushing_flow`: Air changes per hour through night flushing [Air Changes Per Hour]
- `max_heating_energy_per_floor_area`: Maximum heating load per floor area. Set to no.inf for unrestricted heating [C]
- `max_cooling_energy_per_floor_area`: Maximum cooling load. Set to -np.inf for unrestricted cooling [C]
- `heating_supply_system`: The type of heating system
- `cooling_supply_system`: The type of cooling system
- `heating_emission_system`: How the heat is distributed/emitted to the building
- `cooling_emission_system`: How the cooling energy is distributed/emitted to the building
- `dhw_system`: Type of hot water generator
### Example of Execution:
To simulate using default values for the optional arguments:
```bash
dibs_cli simulate-one-building /path/to/file.csv/or/to/file.csv
```
To simulate using custom values for all arguments:
```bash
dibs_cli simulate-one-building /path/to/file.csv/or/to/file.csv --profile_from_norm din18599 --gains_from_group_values mid --usage_from_norm sia2024 --weather_period 2007-2021
```
The below command will use the default values for `--profile_from_norm`, `--usage_from_norm`, and `--weather_period`, while using
the provided value for `--gains_from_group_values`.
```bash
python dibs_cli simulate-one-building /path/to/file.csv/or/to/file.csv --gains_from_group_values mid
```
### Calling for Help
To get help on the available commands and options, use the `--help` flag. For example:
```bash
dibs_cli --help
```
This will display an overview of the available commands and their options.
## License
This program is licensed under the [MIT License](LICENSE). See the license file for more information.
Raw data
{
"_id": null,
"home_page": null,
"name": "dibs-cli",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10.0",
"maintainer_email": null,
"keywords": "Building, Building-Stock, Non-Domestic, Non-Residential, Operational, Energy, Greenhouse Gas, Global Warming Potential, Simulation, Model, Germany, ISO 13790, 5R1C",
"author": "Simon Knoll, Michael H\u00f6rner",
"author_email": "Julian Bischof <j.bischof@iwu.de>, Wail Samjouni <w.samjouni@iwu.de>, Andr\u00e9 M\u00fcller <a.mueller@iwu.de>, Jens Calisti <j.calisti@iwu.de>",
"download_url": "https://files.pythonhosted.org/packages/7d/d3/7cb69bb76f48bba718207d6167113696ca2e8057e864fbd97f7003b0d2c8/dibs_cli-1.0.1.tar.gz",
"platform": null,
"description": "# Building Simulation CLI\n\nThis Python program provides a command-line interface (CLI) for simulating buildings based on data provided in a CSV or\nExcel file. The program offers two main commands (`simulate_one_building` and `simulate_all_building`) to simulate\nindividual buildings or multiple buildings simultaneously.\n\n## Prerequisites\n\nBefore running this program, ensure you have Python 3.10 or higher installed on your system. If Python is not already\ninstalled, you can download and install it from the official website: [Python.org](https://www.python.org/downloads/)\n\n### Installing Python\n\n1. Visit the [Python Downloads](https://www.python.org/downloads/) page.\n2. Choose the version appropriate for your operating system (Windows, macOS, or Linux) and click on the download link.\n3. Run the installer and follow the installation instructions.\n4. During the installation process, make sure to check the box that says \"Add Python to PATH\" or \"Add Python to\n environment variables\" to ensure Python is added to your system PATH.\n5. Once the installation is complete, open a command prompt or terminal and type `python --version` to verify that\n Python is installed correctly.\n\n#### Usage\n\nTo execute the CLI, use the provided Python script `dibs_cli.py`. The program expects the path to the file containing\nbuilding data as the first argument. The remaining four arguments are optional and have default values. If the user only\nprovides the path argument, the program will use default values for the other arguments. If the user provides all five\narguments, the program will simulate using the user's input.\n\n### Command `simulate_one_building`\n\nThe `simulate_one` command performs the simulation for a single building. The building data must be provided as a CSV or\nExcel file and contain only one record.\n\n### Command `simulate_all_building`\n\nThe `simulate_all` command performs the simulation for multiple buildings. The building data must be provided as a CSV\nor Excel file and contain multiple records. Each record must match the same pattern and have the same number of\nattributes as a building object.\n\n### Arguments:\n\n- `path`: Path to the file containing building data type of `str`. (Required)\n- `profile_from_norm`: type of `str`. (Optional)\n- `gains_from_group_values`: type of `str`. (Optional)\n- `usage_from_norm`: type of `str`. (Optional)\n- `weather_period`: type of `str`. (Optional)\n\n### CSV File Format Requirements:\n\n- The CSV or Excel file must contain a specific number of columns.\n- The column names in the CSV or Excel file must match the attributes of the building object to be simulated.\n\n#### Example Building Object:\n\nSuppose we have a `Building` object with the following attributes:\n\n\nCorresponding CSV or Excel File Columns:\nTo simulate this Building object, the CSV or Excel file must have the following columns:\n\n- `scr_gebaeude_id`: Building Screening-ID.\n- `plz`: Zipcode of building's location in Germany.\n- `hk_geb`: Usage type (main category)\n- `uk_geb`: Usage type (subcategory)\n- `max_occupancy`: Max. number of building occupants at any given time\n- `wall_area_og`: Area of all walls above ground in contact with the outside [m2]\n- `wall_area_ug`: Area of all walls below ground in contact with soil [m2] \n- `window_area_north`: Area of the glazed surface in contact with the outside facing north [m2]\n- `window_area_east`: Area of the glazed surface in contact with the outside facing east [m2]\n- `window_area_south`: Area of the glazed surface in contact with the outside facing south [m2]\n- `window_area_west`: Area of the glazed surface in contact with the outside facing west [m2]\n- `roof_area`: Area of the roof in contact with the outside [m2]\n- `net_room_area`: Area of all floor areas from usable rooms including all floor plan levels of the building (Refers\n to \"Netto-Raumfl\u00e4che\", DIN 277-1:2016-01) [m2]\n- `energy_ref_area`: Energy reference area of the building [m2]\n- `base_area`: Area for the calculation of transmission heat losses to the soil. Also used to calculate the building's\n volume. [m2]\n- `gross_base_area`: Gross base area of the building gross_base_area = base_area / 0.87 (currently unused)\n- `building_height`: Mean height of the building [m]\n- `net_volume`: Thermally conditioned net volum of building (air filled space within the building) (currently unused) [m3]\n- `gross_volume`: Thermally conditioned gross volum of building (air filled space within the building) (currently unused) [m3]\n- `envelope_area`: Total area of building envelope (currently unused) [m2]\n- `lighting_load`: Lighting Load [W/m2]\n- `lighting_control`: Lux threshold at which the lights turn on [Lx]\n- `lighting_utilisation_factor`: A factor that determines how much natural solar lumminace is effectively utilised in\n the space\n- `lighting_maintenance_factor`: A factor based on how dirty the windows area\n- `aw_construction`: Exterior wall construction type (currently unused)\n- `shading_device`: Type of shading device for transparent surfaces including windows (currently ununsed)\n- `shading_solar_transmittance`: Shading transmittance reduction factor for solar gains (currently ununsed)\n- `glass_solar_transmittance`: Solar radiation passing through the window (g-value)\n- `glass_solar_shading_transmittance`: Solar radiation passing through the window with active shading devices\n- `glass_light_transmittance`: Solar illuminance passing through the window\n- `u_windows`: U value of glazed and/or transparent surfaces [W/m2K]\n- `u_walls`: U value of external walls [W/m2K]\n- `u_roof`: U value of the roof [W/m2K]\n- `u_base`: U value of the floor [W/m2K]\n- `temp_adj_base`: Temperature adjustment factor for the floor\n- `temp_adj_walls_ug`: Temperature adjustment factor for walls below ground\n- `ach_inf`: Air changes per hour through infiltration [Air Changes Per Hour]\n- `ach_win`: Air changes per hour through opened windows [Air Changes Per Hour]\n- `ach_vent`: Air changes per hour through ventilation [Air Changes Per Hour]\n- `heat_recovery_efficiency`: Efficiency of heat recovery\n- `thermal_capacitance`: Thermal capacitance of the building [J/m2K]\n- `t_set_heating`: Thermal heating set point [C]\n- `t_start`: Indoor air temperatur for first time step of the simulation [C]\n- `t_set_cooling`: Thermal cooling set point [C]\n- `night_flushing_flow`: Air changes per hour through night flushing [Air Changes Per Hour]\n- `max_heating_energy_per_floor_area`: Maximum heating load per floor area. Set to no.inf for unrestricted heating [C]\n- `max_cooling_energy_per_floor_area`: Maximum cooling load. Set to -np.inf for unrestricted cooling [C]\n- `heating_supply_system`: The type of heating system\n- `cooling_supply_system`: The type of cooling system\n- `heating_emission_system`: How the heat is distributed/emitted to the building\n- `cooling_emission_system`: How the cooling energy is distributed/emitted to the building\n- `dhw_system`: Type of hot water generator\n\n### Example of Execution:\n\nTo simulate using default values for the optional arguments:\n\n```bash\ndibs_cli simulate-one-building /path/to/file.csv/or/to/file.csv\n```\n\nTo simulate using custom values for all arguments:\n\n```bash\ndibs_cli simulate-one-building /path/to/file.csv/or/to/file.csv --profile_from_norm din18599 --gains_from_group_values mid --usage_from_norm sia2024 --weather_period 2007-2021\n```\n\nThe below command will use the default values for `--profile_from_norm`, `--usage_from_norm`, and `--weather_period`, while using\nthe provided value for `--gains_from_group_values`.\n\n```bash\npython dibs_cli simulate-one-building /path/to/file.csv/or/to/file.csv --gains_from_group_values mid\n```\n\n### Calling for Help\n\nTo get help on the available commands and options, use the `--help` flag. For example:\n\n```bash\ndibs_cli --help\n```\n\nThis will display an overview of the available commands and their options.\n\n## License\n\nThis program is licensed under the [MIT License](LICENSE). See the license file for more information.\n\n",
"bugtrack_url": null,
"license": null,
"summary": "DIBS---Dynamic-ISO-Building-Simulator command line interface (CLI): DIBS---Dynamic-ISO-Building-Simulator is a simulation program for calculating the space heating, occupancy hot water, cooling and electricity demand of German non-residential buildings. Further the DIBS calculates the heating value based energy uses, the primary energy and the greenhouse gas emission. The underlying resistance-capacity-model is based on the simplified hourly method of ISO 13790:2008.",
"version": "1.0.1",
"project_urls": {
"Repository": "https://github.com/IWUGERMANY/DibsCLI"
},
"split_keywords": [
"building",
" building-stock",
" non-domestic",
" non-residential",
" operational",
" energy",
" greenhouse gas",
" global warming potential",
" simulation",
" model",
" germany",
" iso 13790",
" 5r1c"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "49d7387fe34096dfc195a3fbd86bdeee31b93556f3eacfde74bcbf589e3f11fc",
"md5": "a5983a0cda6cd5d095ec09ad0e06194a",
"sha256": "74b6e8bd0050de94500acb3f5ee3e4f66d5913043a86d609cde3365f91afd45e"
},
"downloads": -1,
"filename": "dibs_cli-1.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a5983a0cda6cd5d095ec09ad0e06194a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10.0",
"size": 10966,
"upload_time": "2024-04-09T10:37:50",
"upload_time_iso_8601": "2024-04-09T10:37:50.140239Z",
"url": "https://files.pythonhosted.org/packages/49/d7/387fe34096dfc195a3fbd86bdeee31b93556f3eacfde74bcbf589e3f11fc/dibs_cli-1.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "7dd37cb69bb76f48bba718207d6167113696ca2e8057e864fbd97f7003b0d2c8",
"md5": "0ec0799aa7a87341e0c3a293aa0369ab",
"sha256": "391c5e7f5f11451e81131b8816a5905d96592261bf5f5059c6fd367c73debb7c"
},
"downloads": -1,
"filename": "dibs_cli-1.0.1.tar.gz",
"has_sig": false,
"md5_digest": "0ec0799aa7a87341e0c3a293aa0369ab",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10.0",
"size": 12320,
"upload_time": "2024-04-09T10:37:52",
"upload_time_iso_8601": "2024-04-09T10:37:52.045989Z",
"url": "https://files.pythonhosted.org/packages/7d/d3/7cb69bb76f48bba718207d6167113696ca2e8057e864fbd97f7003b0d2c8/dibs_cli-1.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-09 10:37:52",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "IWUGERMANY",
"github_project": "DibsCLI",
"github_not_found": true,
"lcname": "dibs-cli"
}
JSON
