pybuildingenergy


Namepybuildingenergy JSON
Version 1.0.7 PyPI version JSON
download
home_pagehttps://github.com/EURAC-EEBgroup/pyBuildingEnergy
SummaryEnergy Simulation of building usin ISO52016 and more
upload_time2024-04-18 14:31:30
maintainerNone
docs_urlNone
authorDaniele Antonucci
requires_python>=3.8.0
licenseMIT License Copyright (c) 2024, Daniele Antonucci Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
keywords energy building heating and cooling 52016 epbd
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            ================
pyBuildingEnergy
================


.. image:: https://github.com/EURAC-EEBgroup/pyBuildingEnergy/blob/master/src/pybuildingenergy/assets/Logo_pyBuild.png
   :width: 800
   :height: 250

Citation
----------
Please cite us if you use the library

.. image:: https://zenodo.org/badge/761715706.svg
  :target: https://zenodo.org/doi/10.5281/zenodo.10887919

Features
--------

The new EPBD recast provides an update on building performance assessment through a methodology that must take into account various aspects such as the thermal characteristics of the building, the use of energy from renewable sources, building automation and control systems, ventilation, cooling, energy recovery, etc.

The methodology should represent the actual operating conditions, allow for the use of measured energy for accuracy and comparability purposes, and be based on hourly or sub-hourly intervals that take into account the variable conditions significantly impacting the operation and performance of the system, as well as internal conditions.
The energy performance of a building shall be expressed by a numeric indicator of primary energy use per unit of reference floor area per year, in kWh/(m2.y) for the purpose of both energy performance certification and compliance with minimum energy performance requirements. Numeric indicators of final energy use per unit of reference floor area per year, in kWh/(m2.y) and of energy needs according to ISO 52000 in kWh/(m².y) shall be used. The methodology applied for the determination of the energy performance of a building shall be transparent and open to innovation and reflect best practices, in particular from additional indicators.
Member States shall describe their national calculation methodology based on Annex A of the key European standards on energy performance of buildings, namely EN ISO 52000-1, EN ISO 52003-1, EN ISO 52010-1,EN ISO 52016-1, EN ISO 52018-1,EN 16798-1, EN 52120-1 and EN 17423 or superseding documents. This provision shall not constitute a legal codification of those standards.

**pyBuildingEnergy** aims to provide an assessment of building performance both in terms of energy and comfort. In this initial release, it is possible to assess the energy performance of the building using ISO 52106-1:2018. Additional modules will be added for a more comprehensive evaluation of performance, assessing ventilation, renewable energies, systems, etc.
The actual calculation methods for the assessment of building performance are the following:

- [x] the (sensible) energy need for heating and cooling, based on hourly or monthly calculations;

- [ ] the latent energy need for (de-)humidification, based on hourly or monthly calculations;

- [x] the internal temperature, based on hourly calculations;

- [x] the sensible heating and cooling load, based on hourly calculations;

- [ ] the moisture and latent heat load for (de-)humidification, based on hourly calculations;

- [ ] the design sensible heating or cooling load and design latent heat load using an hourly calculation interval;

- [ ] the conditions of the supply air to provide the necessary humidification and dehumidification.

The calculation methods can be used for residential or non-residential buildings, or a part of it, referred to as "the building" or the "assessed object".
ISO 52016-1:2018 also contains specifications for the assessment of thermal zones in the building or in the part of a building. The calculations are performed per thermal zone. In the calculations, the thermal zones can be assumed to be thermally coupled or not.
ISO 52016-1:2018 is applicable to buildings at the design stage, to new buildings after construction and to existing buildings in the use phase


Weather Data
------------
The tool can use wather data coming from 2 main sources:

- pvgis api (https://re.jrc.ec.europa.eu/pvg_tools/en/) - PHOTOVOLTAIC GEOGRAPHICAL INFORMATION SYSTEM
- .epw file from https://www.ladybug.tools/epwmap/

More details in the example folder


Domestic Hot Water - DHW
------------------------
- [x] Calculation of volume and energy need for domestic hot water according to ISO 12831-3. 
- [] Assessment of thermal load based on the type of DHW system


Limitations
------------
The library is developed with the intent of demonstrating specific elements of calculation procedures in the relevant standards. It is not intended to replace the regulations but to complement them, as the latter are essential for understanding the calculation. 
This library is meant to be used for demonstration and testing purposes and is therefore provided as open source, without protection against misuse or inappropriate use.

The information and views set out in this document are those of the authors and do not necessarily reflect the official opinion of the European Union. Neither the European Union institutions and bodies nor any person acting on their behalf may be held responsible for the use that may be made of the information contained herein.

The calculation is currently aimed at single-zone buildings with ground floor. The evaluation of multi-zone buildings is under evaluation.

Getting Started
----------------
The following command will install the latest pyBuildinEnergy library

::

    pip install pybuildingenergy


The tool allows you to evaluate the performance of buildings in different ways: 

* by running simulations of buildings (archetypes) already preloaded in the archetypes.pickle file for different nations according to Tabula dataset (currently only Italian buildings are available, but buildings from different nations will be loaded), 

  ::

      python3 pybuildingenergy --archetype


Here it is possible, to select two options:
  

  . Selection of archetype by providing
  
    * information on building type: single_family_house 
    * period of construction: before 1900, 1901-1920,1921-1945,1946-1960,1961-1875,1976-1990,1991-2005,2006-today 
    * location: 
        **latitude** and **longitude**

  . Demo Building having these features: 

     * single_family_house
     * before 1900,
     * city: Turin
     * lat: 45.071321703968124
     * long: 7.642963669564985
    

* by running best_test600 demo:

  ::

      python3 pybuildingenergy --best_test


* your own building.  For the latter, you can either upload the information from scratch or preload the information from a building archetype and then edit only the information you know.
  
  See `Examples <https://github.com/EURAC-EEBgroup/pyBuildingEnergy/tree/master/examples>`_ folder
  


Building Inputs
----------------

.. list-table:: Building geometry data * general
   :widths: 20 20 40 10 10 
   :header-rows: 1

   * - Parameter
     - Key
     - Description
     - Unit
     - Mandatory
   * - **Latitude**
     - latitude
     - latitude of the building in [decimal] 
     - [-]
     - YES
   * - **Longitude**
     - longitude
     - longitude of the building location [decimal]
     - [-].
     - YES
   * - **Coldest month**
     - coldest_month
     - Define the coldest month of the building location. Value from 1 (January) to 12 (December)
     - [-].
     - YES. Default: 1
   * - **Gross building area**
     - a_use
     - gross floor area of the building
     - [m2]
     - YES
   * - **Slab on ground area** 
     - slab_on_ground_area
     - Ground floor gross area
     - [m2]
     - If not provided, the slab on ground are is calculated as useful area / number of floors
   * - **Number of floors**
     - number_of_floor
     - Number of building floors 
     - [-]
     - YES/NO if number of floors is provided
   * - **Building perimeter**
     - exposed_perimeter
     - perimeter of the building
     - [m]
     - YES/NO iIf not provided, the perimeter is calculated as if the building were rectangular with one side being 10 meters
   * - **Building height**
     - height
     - external height of the building
     - [m]
     - YES
   * - **Average thickness of wall**
     - wall_thickness
     - average thickness of building walls 
     - [m]
     - YES
   * - **Surface of envelope**
     - surface_envelope
     - gross volume of the building 
     - [m3]
     - If not provided the volume is calcuated as the slab on ground area * building height
   * - **Volume**
     - volume
     - gross volume of the building 
     - [m3]
     - If not provided the volume is calcuated as the slab on ground area * building height
   * - **Annual mean internal temperature**
     - annual_mean_internal_temperature
     - the annual mean internal temperature is the average between Heating and Cooling setpoints
     - [°C]
     - NO: if not provided, it is calculated.
   * - **Annual mean external temperature**
     - annual_mean_external_temperature
     - Annual mean axternal temperature of the building location
     - [°C]
     - NO: if not provided, it is calculated.
   * - **Heating system**
     - heating_mode
     - True if heating system is installed, False if not.
     - [True or False]
     - YES
   * - **Cooling system**
     - cooling-mode
     - True if heating system is installed, False if not.
     - [True or False]
     - YES 
   * - **Heating setpoint**
     - heating_setpoint
     - Temperature set-point of the heating system
     - [°C]
     - YES. If `heating_mode` is True
   * - **Cooling setpoint**
     - cooling_setpoint
     - Temperature set-point of the cooling system
     - [°C]
     - YES. If `cooling_mode` is True
   * - **Heating setback**
     - heating_setback
     - Temperature set-back of the heating system
     - [°C]
     - YES. If `heating_mode` is True
   * - **Cooling setback**
     - cooling_setback
     - Temperature set-back of the cooling system
     - [°C]
     - YES. If `cooling_mode` is True
   * - **Max power of heating generator**
     - power_heating_max
     - max power of heating generator
     - [W]
     - YES. If `heating_mode` is True
   * - **Max power of cooling generator**
     - power_cooling_max
     - max power of cooling generator
     - [W]
     - YES. If `cooling_mode` is True
   * - **Air change rate**
     - air_change_rate_base_value
     - value of air chnage rate
     - [m3/h*m2]
     - Yes
   * - **Air change rate extra**
     - air_change_rate_extra
     - extra value of air change rate, in specific period according to the occupancy profile
     - [m3/h*m2]
     - Yes
   * - **Internal Gains**
     - internal_gains_base_value
     - power of internal gains 
     - [W/m2] 
     - YES
   * - **Extra Internal Gains**
     - internal_gains_base_value
     - extra value of internal gains, in specific period according to the occupancy profile
     - [W/m2] 
     - YES
   * - **Thermal bridges**
     - thermal_bridge_heat
     - Overall heat transfer coefficient for thermal bridges (without groud floor)
     - [W/K] 
     - YES
   * - **Thermal resistance of floor**
     - thermal_resistance_floor
     - Average thermal resistance of internal floors
     - [m2K/W] 
     - YES
   * - **Facade elements type**
     - typology_elements
     - List of all facade elements (Walls, Roof, Ground Floor, Windows).For:
        * Wall, Roof use: "OP" (Opaque elements)
        * Ground Floor: use "GF" (Ground Floor)
        * Windows: use "W" (Windows)
     - [-] 
     - YES
   * - **Orienation of facade elements**
     - orientation_elements
     - For each elements of the facade provide the orientation, according to the following abbreviations:
        * NV: North Vertical
        * SV: South Vertical
        * EV: East Vertical
        * WV: West Vertical
        * HOR: Horizontal/Slope (for roof and ground floor)
     - [-] 
     - YES
   * - **Solar absorption coefficients**
     - solar_abs_elements
     - Solar absorption coefficient of external (Opaque) facade elements (e.g. walls)
     - [-] 
     - YES
   * - **Area of facade elements**
     - area_elements
     - Area of each facade element (e.g. Wall, Window, etc.)
     - [m2] 
     - YES
   * - **Transmittance - U**
     - transmittance_U_elements
     - Transmiattance of each facade element.
     - [W/m2K] 
     - YES
   * - **Resistance - U**
     - thermal_resistance_R_elements
     - Theraml Resistance of each facade element. 
     - [W/m2K] 
     - YES
   * - **Thermal capacity - k**
     - thermal_resistance_R_elements
     - Addition of the heat capacity of each layer (i.e. calculated by multiplying the density times its thickness times the SHC of the material)
     - [J/m2K] 
     - YES
   * - **g-value**
     - g_factor_windows
     - solar energy transmittance of windows
     - [-] 
     - YES
   * - **Heat radiative transfer coefficient - internal**
     - heat_convective_elements_internal
     - convective heat transfer coefficient internal surface for each element
     - [W/m2K] 
     - YES
   * - **Heat convective transfer coefficient - external**
     - heat_convective_elements_external
     - convective heat transfer coefficient external surface for each element
     - [W/m2K] 
     - YES
   * - **Heat radiative transfer coefficient - internal**
     - heat_radiative_elements_internal
     - radiative heat transfer coefficient internal surface for each element
     - [W/m2K] 
     - YES
   * - **Heat radiative transfer coefficient - external**
     - heat_radiative_elements_external
     - radiative heat transfer coefficient external surface for each element
     - [W/m2K] 
     - YES
   * - **View factor**
     - sky_factor_elements
     - View factor between building element and the sky
     - [-] 
     - YES
   * - **Occupancy profile workdays - internal_gains rate**
     - comf_level_we
     - Occupancy profile for workdays to evalaute the utilization of extra internal gains
     - [-] 
     - YES
   * - **Occupancy profile weekends - internal_gains rate**
     - comf_level_we
     - Occupancy profile for weekdays to evalaute the utilization of extra internal gains
     - [-] 
     - YES
   * - **Occupancy profile workdays - airflow rate**
     - comf_level_we
     - Occupancy profile for workdays to evalaute the utilization of extra air change rate
     - [-] 
     - YES
   * - **Occupancy profile weekend - airflow rate**
     - comf_level_we
     - Occupancy profile for weekend to evalaute the utilization of extra air change rate
     - [-] 
     - YES
   * - **Class of buidling construction**
     - construction_class
     - Distribution of the mass for opaque elements (vertical - walls and horizontal - floor/roof) as described in Table B.13 of ISO52016. Possible choices: class_i, class_e, class_ie, class_d
     - [-] 
     - YES
   * - **Weather source**
     - weather_source
     - In English, it would be: "Select which type of source to use for weather data. Choose 'pvgis' for connecting to the `pvgis <https://re.jrc.ec.europa.eu/pvg_tools/en/>` or 'epw' file if using an epw file, to be download from `here <https://www.ladybug.tools/epwmap/>`
     - [-] 
     - YES
   
More information about coefficients are available `here <https://github.com/EURAC-EEBgroup/pyBuildingEnergy/tree/master/src/pybuildingenergy/data>`


Documentation
--------------
Check our doc `here <https://pybuildingenergy.readthedocs.io/en/latest/>`

Example
-------

Here some `Examples <https://github.com/EURAC-EEBgroup/pyBuildingEnergy/tree/master/examples>` on pybuildingenergy application.
For more information
.....
  

Contributing and Support
-------------------------

**Bug reports/Questions**
If you encounter a bug, kindly create a GitLab issue detailing the bug. 
Please provide steps to reproduce the issue and ideally, include a snippet of code that triggers the bug. 
If the bug results in an error, include the traceback. If it leads to unexpected behavior, specify the expected behavior.

**Code contributions**
We welcome and deeply appreciate contributions! Every contribution, no matter how small, makes a difference. Click here to find out more about contributing to the project.


License
--------
* Free software: MIT license
* Documentation: https://pybuildingenergy.readthedocs.io.

Acknowledgment
---------------
This work was carried out within European projects: 
Infinite - This project has received funding from the European Union’s Horizon 2020 research and innovation programme under grant agreement No 958397, 
Moderate - Horizon Europe research and innovation programme under grant agreement No 101069834, 
with the aim of contributing to the development of open products useful for defining plausible scenarios for the decarbonization of the built environment

Reagrding the DHW Calculation: 
The work was developed using the regulations and results obtained from the spreadsheet created by the EPBCenter.

Reference
----------
- EN ISO 52010-1:2018 Energy performance of buildings - External climatic conditions - Part 1: Conversion of climatic data for energy calculations
- EN ISO 52016-1:2018 Energy performance of buildings - Energy needs for heating and cooling, internal temperatures and sensible and latent heat loads 
- EN ISO 12831-3:2018 Energy performance of buildings - Method for calculation of the design heat load - Part 3: Domestic hot water systems heat load and characterisation of needs, Module M8-2, M8-3





            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/EURAC-EEBgroup/pyBuildingEnergy",
    "name": "pybuildingenergy",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.8.0",
    "maintainer_email": "Daniele Antonucci <daniele.antonucci@eurac.edu>",
    "keywords": "energy, building, heating and cooling, 52016, EPBD",
    "author": "Daniele Antonucci",
    "author_email": "Daniele Antonucci <daniele.antonucci@eurac.edu>",
    "download_url": "https://files.pythonhosted.org/packages/c3/53/01781a0b1c108c5fdbb4714b1d4d8996842ec0057f799c0897f857a14d00/pybuildingenergy-1.0.7.tar.gz",
    "platform": null,
    "description": "================\npyBuildingEnergy\n================\n\n\n.. image:: https://github.com/EURAC-EEBgroup/pyBuildingEnergy/blob/master/src/pybuildingenergy/assets/Logo_pyBuild.png\n   :width: 800\n   :height: 250\n\nCitation\n----------\nPlease cite us if you use the library\n\n.. image:: https://zenodo.org/badge/761715706.svg\n  :target: https://zenodo.org/doi/10.5281/zenodo.10887919\n\nFeatures\n--------\n\nThe new EPBD recast provides an update on building performance assessment through a methodology that must take into account various aspects such as the thermal characteristics of the building, the use of energy from renewable sources, building automation and control systems, ventilation, cooling, energy recovery, etc.\n\nThe methodology should represent the actual operating conditions, allow for the use of measured energy for accuracy and comparability purposes, and be based on hourly or sub-hourly intervals that take into account the variable conditions significantly impacting the operation and performance of the system, as well as internal conditions.\nThe energy performance of a building shall be expressed by a numeric indicator of primary energy use per unit of reference floor area per year, in kWh/(m2.y) for the purpose of both energy performance certification and compliance with minimum energy performance requirements. Numeric indicators of final energy use per unit of reference floor area per year, in kWh/(m2.y) and of energy needs according to ISO 52000 in kWh/(m\u00b2.y) shall be used. The methodology applied for the determination of the energy performance of a building shall be transparent and open to innovation and reflect best practices, in particular from additional indicators.\nMember States shall describe their national calculation methodology based on Annex A of the key European standards on energy performance of buildings, namely EN ISO 52000-1, EN ISO 52003-1, EN ISO 52010-1,EN ISO 52016-1, EN ISO 52018-1,EN 16798-1, EN 52120-1 and EN 17423 or superseding documents. This provision shall not constitute a legal codification of those standards.\n\n**pyBuildingEnergy** aims to provide an assessment of building performance both in terms of energy and comfort. In this initial release, it is possible to assess the energy performance of the building using ISO 52106-1:2018. Additional modules will be added for a more comprehensive evaluation of performance, assessing ventilation, renewable energies, systems, etc.\nThe actual calculation methods for the assessment of building performance are the following:\n\n- [x] the (sensible) energy need for heating and cooling, based on hourly or monthly calculations;\n\n- [ ] the latent energy need for (de-)humidification, based on hourly or monthly calculations;\n\n- [x] the internal temperature, based on hourly calculations;\n\n- [x] the sensible heating and cooling load, based on hourly calculations;\n\n- [ ] the moisture and latent heat load for (de-)humidification, based on hourly calculations;\n\n- [ ] the design sensible heating or cooling load and design latent heat load using an hourly calculation interval;\n\n- [ ] the conditions of the supply air to provide the necessary humidification and dehumidification.\n\nThe calculation methods can be used for residential or non-residential buildings, or a part of it, referred to as \"the building\" or the \"assessed object\".\nISO 52016-1:2018 also contains specifications for the assessment of thermal zones in the building or in the part of a building. The calculations are performed per thermal zone. In the calculations, the thermal zones can be assumed to be thermally coupled or not.\nISO 52016-1:2018 is applicable to buildings at the design stage, to new buildings after construction and to existing buildings in the use phase\n\n\nWeather Data\n------------\nThe tool can use wather data coming from 2 main sources:\n\n- pvgis api (https://re.jrc.ec.europa.eu/pvg_tools/en/) - PHOTOVOLTAIC GEOGRAPHICAL INFORMATION SYSTEM\n- .epw file from https://www.ladybug.tools/epwmap/\n\nMore details in the example folder\n\n\nDomestic Hot Water - DHW\n------------------------\n- [x] Calculation of volume and energy need for domestic hot water according to ISO 12831-3. \n- [] Assessment of thermal load based on the type of DHW system\n\n\nLimitations\n------------\nThe library is developed with the intent of demonstrating specific elements of calculation procedures in the relevant standards. It is not intended to replace the regulations but to complement them, as the latter are essential for understanding the calculation. \nThis library is meant to be used for demonstration and testing purposes and is therefore provided as open source, without protection against misuse or inappropriate use.\n\nThe information and views set out in this document are those of the authors and do not necessarily reflect the official opinion of the European Union. Neither the European Union institutions and bodies nor any person acting on their behalf may be held responsible for the use that may be made of the information contained herein.\n\nThe calculation is currently aimed at single-zone buildings with ground floor. The evaluation of multi-zone buildings is under evaluation.\n\nGetting Started\n----------------\nThe following command will install the latest pyBuildinEnergy library\n\n::\n\n    pip install pybuildingenergy\n\n\nThe tool allows you to evaluate the performance of buildings in different ways: \n\n* by running simulations of buildings (archetypes) already preloaded in the archetypes.pickle file for different nations according to Tabula dataset (currently only Italian buildings are available, but buildings from different nations will be loaded), \n\n  ::\n\n      python3 pybuildingenergy --archetype\n\n\nHere it is possible, to select two options:\n  \n\n  . Selection of archetype by providing\n  \n    * information on building type: single_family_house \n    * period of construction: before 1900, 1901-1920,1921-1945,1946-1960,1961-1875,1976-1990,1991-2005,2006-today \n    * location: \n        **latitude** and **longitude**\n\n  . Demo Building having these features: \n\n     * single_family_house\n     * before 1900,\n     * city: Turin\n     * lat: 45.071321703968124\n     * long: 7.642963669564985\n    \n\n* by running best_test600 demo:\n\n  ::\n\n      python3 pybuildingenergy --best_test\n\n\n* your own building.  For the latter, you can either upload the information from scratch or preload the information from a building archetype and then edit only the information you know.\n  \n  See `Examples <https://github.com/EURAC-EEBgroup/pyBuildingEnergy/tree/master/examples>`_ folder\n  \n\n\nBuilding Inputs\n----------------\n\n.. list-table:: Building geometry data * general\n   :widths: 20 20 40 10 10 \n   :header-rows: 1\n\n   * - Parameter\n     - Key\n     - Description\n     - Unit\n     - Mandatory\n   * - **Latitude**\n     - latitude\n     - latitude of the building in [decimal] \n     - [-]\n     - YES\n   * - **Longitude**\n     - longitude\n     - longitude of the building location [decimal]\n     - [-].\n     - YES\n   * - **Coldest month**\n     - coldest_month\n     - Define the coldest month of the building location. Value from 1 (January) to 12 (December)\n     - [-].\n     - YES. Default: 1\n   * - **Gross building area**\n     - a_use\n     - gross floor area of the building\n     - [m2]\n     - YES\n   * - **Slab on ground area** \n     - slab_on_ground_area\n     - Ground floor gross area\n     - [m2]\n     - If not provided, the slab on ground are is calculated as useful area / number of floors\n   * - **Number of floors**\n     - number_of_floor\n     - Number of building floors \n     - [-]\n     - YES/NO if number of floors is provided\n   * - **Building perimeter**\n     - exposed_perimeter\n     - perimeter of the building\n     - [m]\n     - YES/NO iIf not provided, the perimeter is calculated as if the building were rectangular with one side being 10 meters\n   * - **Building height**\n     - height\n     - external height of the building\n     - [m]\n     - YES\n   * - **Average thickness of wall**\n     - wall_thickness\n     - average thickness of building walls \n     - [m]\n     - YES\n   * - **Surface of envelope**\n     - surface_envelope\n     - gross volume of the building \n     - [m3]\n     - If not provided the volume is calcuated as the slab on ground area * building height\n   * - **Volume**\n     - volume\n     - gross volume of the building \n     - [m3]\n     - If not provided the volume is calcuated as the slab on ground area * building height\n   * - **Annual mean internal temperature**\n     - annual_mean_internal_temperature\n     - the annual mean internal temperature is the average between Heating and Cooling setpoints\n     - [\u00b0C]\n     - NO: if not provided, it is calculated.\n   * - **Annual mean external temperature**\n     - annual_mean_external_temperature\n     - Annual mean axternal temperature of the building location\n     - [\u00b0C]\n     - NO: if not provided, it is calculated.\n   * - **Heating system**\n     - heating_mode\n     - True if heating system is installed, False if not.\n     - [True or False]\n     - YES\n   * - **Cooling system**\n     - cooling-mode\n     - True if heating system is installed, False if not.\n     - [True or False]\n     - YES \n   * - **Heating setpoint**\n     - heating_setpoint\n     - Temperature set-point of the heating system\n     - [\u00b0C]\n     - YES. If `heating_mode` is True\n   * - **Cooling setpoint**\n     - cooling_setpoint\n     - Temperature set-point of the cooling system\n     - [\u00b0C]\n     - YES. If `cooling_mode` is True\n   * - **Heating setback**\n     - heating_setback\n     - Temperature set-back of the heating system\n     - [\u00b0C]\n     - YES. If `heating_mode` is True\n   * - **Cooling setback**\n     - cooling_setback\n     - Temperature set-back of the cooling system\n     - [\u00b0C]\n     - YES. If `cooling_mode` is True\n   * - **Max power of heating generator**\n     - power_heating_max\n     - max power of heating generator\n     - [W]\n     - YES. If `heating_mode` is True\n   * - **Max power of cooling generator**\n     - power_cooling_max\n     - max power of cooling generator\n     - [W]\n     - YES. If `cooling_mode` is True\n   * - **Air change rate**\n     - air_change_rate_base_value\n     - value of air chnage rate\n     - [m3/h*m2]\n     - Yes\n   * - **Air change rate extra**\n     - air_change_rate_extra\n     - extra value of air change rate, in specific period according to the occupancy profile\n     - [m3/h*m2]\n     - Yes\n   * - **Internal Gains**\n     - internal_gains_base_value\n     - power of internal gains \n     - [W/m2] \n     - YES\n   * - **Extra Internal Gains**\n     - internal_gains_base_value\n     - extra value of internal gains, in specific period according to the occupancy profile\n     - [W/m2] \n     - YES\n   * - **Thermal bridges**\n     - thermal_bridge_heat\n     - Overall heat transfer coefficient for thermal bridges (without groud floor)\n     - [W/K] \n     - YES\n   * - **Thermal resistance of floor**\n     - thermal_resistance_floor\n     - Average thermal resistance of internal floors\n     - [m2K/W] \n     - YES\n   * - **Facade elements type**\n     - typology_elements\n     - List of all facade elements (Walls, Roof, Ground Floor, Windows).For:\n        * Wall, Roof use: \"OP\" (Opaque elements)\n        * Ground Floor: use \"GF\" (Ground Floor)\n        * Windows: use \"W\" (Windows)\n     - [-] \n     - YES\n   * - **Orienation of facade elements**\n     - orientation_elements\n     - For each elements of the facade provide the orientation, according to the following abbreviations:\n        * NV: North Vertical\n        * SV: South Vertical\n        * EV: East Vertical\n        * WV: West Vertical\n        * HOR: Horizontal/Slope (for roof and ground floor)\n     - [-] \n     - YES\n   * - **Solar absorption coefficients**\n     - solar_abs_elements\n     - Solar absorption coefficient of external (Opaque) facade elements (e.g. walls)\n     - [-] \n     - YES\n   * - **Area of facade elements**\n     - area_elements\n     - Area of each facade element (e.g. Wall, Window, etc.)\n     - [m2] \n     - YES\n   * - **Transmittance - U**\n     - transmittance_U_elements\n     - Transmiattance of each facade element.\n     - [W/m2K] \n     - YES\n   * - **Resistance - U**\n     - thermal_resistance_R_elements\n     - Theraml Resistance of each facade element. \n     - [W/m2K] \n     - YES\n   * - **Thermal capacity - k**\n     - thermal_resistance_R_elements\n     - Addition of the heat capacity of each layer (i.e. calculated by multiplying the density times its thickness times the SHC of the material)\n     - [J/m2K] \n     - YES\n   * - **g-value**\n     - g_factor_windows\n     - solar energy transmittance of windows\n     - [-] \n     - YES\n   * - **Heat radiative transfer coefficient - internal**\n     - heat_convective_elements_internal\n     - convective heat transfer coefficient internal surface for each element\n     - [W/m2K] \n     - YES\n   * - **Heat convective transfer coefficient - external**\n     - heat_convective_elements_external\n     - convective heat transfer coefficient external surface for each element\n     - [W/m2K] \n     - YES\n   * - **Heat radiative transfer coefficient - internal**\n     - heat_radiative_elements_internal\n     - radiative heat transfer coefficient internal surface for each element\n     - [W/m2K] \n     - YES\n   * - **Heat radiative transfer coefficient - external**\n     - heat_radiative_elements_external\n     - radiative heat transfer coefficient external surface for each element\n     - [W/m2K] \n     - YES\n   * - **View factor**\n     - sky_factor_elements\n     - View factor between building element and the sky\n     - [-] \n     - YES\n   * - **Occupancy profile workdays - internal_gains rate**\n     - comf_level_we\n     - Occupancy profile for workdays to evalaute the utilization of extra internal gains\n     - [-] \n     - YES\n   * - **Occupancy profile weekends - internal_gains rate**\n     - comf_level_we\n     - Occupancy profile for weekdays to evalaute the utilization of extra internal gains\n     - [-] \n     - YES\n   * - **Occupancy profile workdays - airflow rate**\n     - comf_level_we\n     - Occupancy profile for workdays to evalaute the utilization of extra air change rate\n     - [-] \n     - YES\n   * - **Occupancy profile weekend - airflow rate**\n     - comf_level_we\n     - Occupancy profile for weekend to evalaute the utilization of extra air change rate\n     - [-] \n     - YES\n   * - **Class of buidling construction**\n     - construction_class\n     - Distribution of the mass for opaque elements (vertical - walls and horizontal - floor/roof) as described in Table B.13 of ISO52016. Possible choices: class_i, class_e, class_ie, class_d\n     - [-] \n     - YES\n   * - **Weather source**\n     - weather_source\n     - In English, it would be: \"Select which type of source to use for weather data. Choose 'pvgis' for connecting to the `pvgis <https://re.jrc.ec.europa.eu/pvg_tools/en/>` or 'epw' file if using an epw file, to be download from `here <https://www.ladybug.tools/epwmap/>`\n     - [-] \n     - YES\n   \nMore information about coefficients are available `here <https://github.com/EURAC-EEBgroup/pyBuildingEnergy/tree/master/src/pybuildingenergy/data>`\n\n\nDocumentation\n--------------\nCheck our doc `here <https://pybuildingenergy.readthedocs.io/en/latest/>`\n\nExample\n-------\n\nHere some `Examples <https://github.com/EURAC-EEBgroup/pyBuildingEnergy/tree/master/examples>` on pybuildingenergy application.\nFor more information\n.....\n  \n\nContributing and Support\n-------------------------\n\n**Bug reports/Questions**\nIf you encounter a bug, kindly create a GitLab issue detailing the bug. \nPlease provide steps to reproduce the issue and ideally, include a snippet of code that triggers the bug. \nIf the bug results in an error, include the traceback. If it leads to unexpected behavior, specify the expected behavior.\n\n**Code contributions**\nWe welcome and deeply appreciate contributions! Every contribution, no matter how small, makes a difference. Click here to find out more about contributing to the project.\n\n\nLicense\n--------\n* Free software: MIT license\n* Documentation: https://pybuildingenergy.readthedocs.io.\n\nAcknowledgment\n---------------\nThis work was carried out within European projects: \nInfinite - This project has received funding from the European Union\u2019s Horizon 2020 research and innovation programme under grant agreement No 958397, \nModerate - Horizon Europe research and innovation programme under grant agreement No 101069834, \nwith the aim of contributing to the development of open products useful for defining plausible scenarios for the decarbonization of the built environment\n\nReagrding the DHW Calculation: \nThe work was developed using the regulations and results obtained from the spreadsheet created by the EPBCenter.\n\nReference\n----------\n- EN ISO 52010-1:2018 Energy performance of buildings - External climatic conditions - Part 1: Conversion of climatic data for energy calculations\n- EN ISO 52016-1:2018 Energy performance of buildings - Energy needs for heating and cooling, internal temperatures and sensible and latent heat loads \n- EN ISO 12831-3:2018 Energy performance of buildings - Method for calculation of the design heat load - Part 3: Domestic hot water systems heat load and characterisation of needs, Module M8-2, M8-3\n\n\n\n\n",
    "bugtrack_url": null,
    "license": "MIT License  Copyright (c) 2024, Daniele Antonucci  Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:  The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.  THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.  ",
    "summary": "Energy Simulation of building usin ISO52016 and more",
    "version": "1.0.7",
    "project_urls": {
        "Changelog": "https://github.com/EURAC-EEBgroup/pyBuildingEnergy/CHANGELOG.md",
        "Documentation": "https://pybuildingenergy.readthedocs.io/en/latest/Overview/overview.html",
        "Homepage": "https://github.com/EURAC-EEBgroup/pyBuildingEnergy",
        "Issues": "https://github.com/EURAC-EEBgroup/pyBuildingEnergy/issues",
        "Repository": "https://github.com/EURAC-EEBgroup/pyBuildingEnergy"
    },
    "split_keywords": [
        "energy",
        " building",
        " heating and cooling",
        " 52016",
        " epbd"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "614059147e899c271355cc7eb2fcc8abe9cae16e7ed5a2aee442ae6e7b0e3765",
                "md5": "3a43985b0fe8a8adfc8ab47284145286",
                "sha256": "0994fb1d6630ad5158959c7cc8b9b3dbceae9e63c59c383aee7fa557d69452ee"
            },
            "downloads": -1,
            "filename": "pybuildingenergy-1.0.7-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "3a43985b0fe8a8adfc8ab47284145286",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8.0",
            "size": 46955,
            "upload_time": "2024-04-18T14:31:07",
            "upload_time_iso_8601": "2024-04-18T14:31:07.672023Z",
            "url": "https://files.pythonhosted.org/packages/61/40/59147e899c271355cc7eb2fcc8abe9cae16e7ed5a2aee442ae6e7b0e3765/pybuildingenergy-1.0.7-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "c35301781a0b1c108c5fdbb4714b1d4d8996842ec0057f799c0897f857a14d00",
                "md5": "4a657d2ac930ae8e85e248a811a29ded",
                "sha256": "408c38d95786b7ebcc543e7d7354137edd70467f902de5fa597dd3609b7adea7"
            },
            "downloads": -1,
            "filename": "pybuildingenergy-1.0.7.tar.gz",
            "has_sig": false,
            "md5_digest": "4a657d2ac930ae8e85e248a811a29ded",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8.0",
            "size": 10021605,
            "upload_time": "2024-04-18T14:31:30",
            "upload_time_iso_8601": "2024-04-18T14:31:30.312974Z",
            "url": "https://files.pythonhosted.org/packages/c3/53/01781a0b1c108c5fdbb4714b1d4d8996842ec0057f799c0897f857a14d00/pybuildingenergy-1.0.7.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-04-18 14:31:30",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "EURAC-EEBgroup",
    "github_project": "pyBuildingEnergy",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "requirements": [],
    "tox": true,
    "lcname": "pybuildingenergy"
}
        
Elapsed time: 0.24020s