buildingmodel 1.0.0__tar.gz

buildingmodel-1.0.0/LICENCE.md

@@ -0,0 +1,27 @@
+The MIT License (MIT)
+=====================
+
+- Copyright © `2021` `Antoine Rogeau`
+- Copyright © `2021` `Robin Girard`
+- Copyright © `2021` `Seddik Yassine Abdelouadoud`
+
+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.

buildingmodel-1.0.0/LICENSE

@@ -0,0 +1,27 @@
+The MIT License (MIT)
+=====================
+
+- Copyright © `2021` `Antoine Rogeau`
+- Copyright © `2021` `Robin Girard`
+- Copyright © `2021` `Seddik Yassine Abdelouadoud`
+
+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.

buildingmodel-1.0.0/PKG-INFO

@@ -0,0 +1,168 @@
+Metadata-Version: 2.4
+Name: buildingmodel
+Version: 1.0.0
+Summary: District-level energy simulation of buildings
+Author-email: Yassine Abdelouadoud <yassine.abdelouadoud@gmail.com>
+Maintainer-email: Yassine Abdelouadoud <yassine.abdelouadoud@gmail.com>
+License: The MIT License (MIT)
+        =====================
+        
+        - Copyright © `2021` `Antoine Rogeau`
+        - Copyright © `2021` `Robin Girard`
+        - Copyright © `2021` `Seddik Yassine Abdelouadoud`
+        
+        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.
+        
+Classifier: Development Status :: 3 - Alpha
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: MacOS :: MacOS X
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Scientific/Engineering :: Physics
+Requires-Python: <4.0.0,>=3.8
+Description-Content-Type: text/markdown
+License-File: LICENCE.md
+License-File: LICENSE
+Requires-Dist: geopandas
+Requires-Dist: numpy
+Requires-Dist: polars
+Requires-Dist: pyarrow
+Requires-Dist: topojson
+Requires-Dist: simplification
+Requires-Dist: pvlib
+Requires-Dist: metalog
+Requires-Dist: environs
+Requires-Dist: tqdm
+Requires-Dist: xarray
+Requires-Dist: pyyaml
+Requires-Dist: buildingdata[era5]
+Provides-Extra: dev
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: pytest-cov; extra == "dev"
+Requires-Dist: ruff; extra == "dev"
+Requires-Dist: bandit; extra == "dev"
+Requires-Dist: pip-audit; extra == "dev"
+Requires-Dist: Cython; extra == "dev"
+Dynamic: license-file
+
+# BuildingModel
+
+**Description**:  BuildingModel is a district-level building energy simulation tool designed to leverage the availability
+of large scale open datasets on building geometry, census-derived dwelling characteristics and energy performance diagnosis.
+The methodology proposed combines GIS data processing with statistical inference techniques to obtain a 
+description of each building's envelop geometry (including adjacency), thermal performances (envelop and systems) 
+and occupation. This description is then used as the input of a physical model calculating solar gains, losses through
+boundaries and ventilation, heating system consumption and occupant-related energy usage.
+
+  - **Technology stack**: Python 3, GeoPandas
+  - **Status**:  Beta (0.2). The complete toolchain is functional, but validation and fine-tuning of the models are still ongoing.
+
+**Screenshot**: 
+Example of results that can be obtained from a BuildingModel run with the GeoPandas integration allowing easy interactive plotting in Jupyter Notebooks
+
+![](./doc/source/images/energy_by_floor_surface.png)
+
+**Documentation**:
+The complete documentation for buildingmodel (methodology and API) is available at [DOCS](https://energytransition.gitlab.io/buildingmodel/)
+
+## Limitations
+BuildingModel has been developed and tested only in the French context, for which GIS, census and energy
+diagnosis data is available. However, the generic character of the methodology should make it suitable for other 
+countries as long as similar datasets can be obtained.
+In addition, BuildingModel currently deals only with residential buildings, due to limitations on the availability of data for other building usages.
+
+## Dependencies
+
+BuildingModel depends mainly on Python 3 (currently tested on Python 3.8) and GeoPandas. A detailed set of dependencies
+is available in [requirements.txt](./ci/requirements.txt)
+
+## Installation
+
+Detailed installation instructions available at [INSTALL](INSTALL.md).
+
+## Usage
+
+In its most basic form, BuildingModel can be used by invoking the high level `run_all` function and passing it the
+path to the building GIS file :
+
+```python
+from buildingmodel.main import run_all, Parameters
+from buildingmodel import data_path
+from pathlib import Path
+
+parameters = Parameters()
+buildings, boundaries, climate, dwellings = run_all(Path(data_path['gis']) / 'testing' / 'test_sample.gpkg',
+                                            None, parameters)
+```
+
+The results returned ar GeoDataFrame in the case of buildings and boundaries and DataFrame in the case of the climate
+and dwellings. More advanced uses and result processing are available as jupyter notebook examples in the documentation.
+
+## How to test the software
+
+From the root folder of BuildingModel, run :
+
+```
+pytest
+```
+
+## Known issues
+
+- Current occupant-related energy usage models are very crude and subject significant future changes. 
+- Energy consumption of heating systems relies on a constant efficiency model that will be replaced by technology-specific models (in particular
+for heat pumps). 
+- Peak consumption estimates are provided by building but cannot be summed directly to obtain the 
+  total peak consumption of the district as the peaks may not be all synchronous.
+- Consumption of cooling systems is not modelled
+
+## Getting help
+
+If you have questions, concerns, bug reports, etc, please file an issue in this repository's Issue Tracker.
+
+## Getting involved
+
+BuildingModel is looking for users to provide feedback and bug reports on the initial set of functionalities as well as
+developers to contribute to the next versions, with a focus on validation of models, cooling need simulation,
+adaptation to other countries' datasets and building usages.
+
+Instructions on how to contribute are available at [CONTRIBUTING](CONTRIBUTING.md).
+
+
+## Open source licensing info
+1. [LICENSE](LICENSE)
+
+----
+
+## Credits and references
+BuildingModel physical models are directly derived from the work of Antoine Rogeau in [
+Vers une approche intégrée d’aide à la planification énergétique territoriale : application à la rénovation énergétique des bâtiments](https://www.theses.fr/2020UPSLM014)
+
+### Funding :
+
+### Main contributors : 
+- Antoine Rogeau
+- [Robin Girard](https://www.minesparis.psl.eu/Services/Annuaire/robin-girard) -- [gitHub](https://github.com/robingirard) [LinkedIn](https://www.linkedin.com/in/robin-girard-a88baa4/) [google Scholar](https://scholar.google.fr/citations?user=cEYGStIAAAAJ&hl=fr)
+- Seddik Yassine Abdelouadoud

buildingmodel-1.0.0/README.md

@@ -0,0 +1,98 @@
+# BuildingModel
+
+**Description**:  BuildingModel is a district-level building energy simulation tool designed to leverage the availability
+of large scale open datasets on building geometry, census-derived dwelling characteristics and energy performance diagnosis.
+The methodology proposed combines GIS data processing with statistical inference techniques to obtain a 
+description of each building's envelop geometry (including adjacency), thermal performances (envelop and systems) 
+and occupation. This description is then used as the input of a physical model calculating solar gains, losses through
+boundaries and ventilation, heating system consumption and occupant-related energy usage.
+
+  - **Technology stack**: Python 3, GeoPandas
+  - **Status**:  Beta (0.2). The complete toolchain is functional, but validation and fine-tuning of the models are still ongoing.
+
+**Screenshot**: 
+Example of results that can be obtained from a BuildingModel run with the GeoPandas integration allowing easy interactive plotting in Jupyter Notebooks
+
+![](./doc/source/images/energy_by_floor_surface.png)
+
+**Documentation**:
+The complete documentation for buildingmodel (methodology and API) is available at [DOCS](https://energytransition.gitlab.io/buildingmodel/)
+
+## Limitations
+BuildingModel has been developed and tested only in the French context, for which GIS, census and energy
+diagnosis data is available. However, the generic character of the methodology should make it suitable for other 
+countries as long as similar datasets can be obtained.
+In addition, BuildingModel currently deals only with residential buildings, due to limitations on the availability of data for other building usages.
+
+## Dependencies
+
+BuildingModel depends mainly on Python 3 (currently tested on Python 3.8) and GeoPandas. A detailed set of dependencies
+is available in [requirements.txt](./ci/requirements.txt)
+
+## Installation
+
+Detailed installation instructions available at [INSTALL](INSTALL.md).
+
+## Usage
+
+In its most basic form, BuildingModel can be used by invoking the high level `run_all` function and passing it the
+path to the building GIS file :
+
+```python
+from buildingmodel.main import run_all, Parameters
+from buildingmodel import data_path
+from pathlib import Path
+
+parameters = Parameters()
+buildings, boundaries, climate, dwellings = run_all(Path(data_path['gis']) / 'testing' / 'test_sample.gpkg',
+                                            None, parameters)
+```
+
+The results returned ar GeoDataFrame in the case of buildings and boundaries and DataFrame in the case of the climate
+and dwellings. More advanced uses and result processing are available as jupyter notebook examples in the documentation.
+
+## How to test the software
+
+From the root folder of BuildingModel, run :
+
+```
+pytest
+```
+
+## Known issues
+
+- Current occupant-related energy usage models are very crude and subject significant future changes. 
+- Energy consumption of heating systems relies on a constant efficiency model that will be replaced by technology-specific models (in particular
+for heat pumps). 
+- Peak consumption estimates are provided by building but cannot be summed directly to obtain the 
+  total peak consumption of the district as the peaks may not be all synchronous.
+- Consumption of cooling systems is not modelled
+
+## Getting help
+
+If you have questions, concerns, bug reports, etc, please file an issue in this repository's Issue Tracker.
+
+## Getting involved
+
+BuildingModel is looking for users to provide feedback and bug reports on the initial set of functionalities as well as
+developers to contribute to the next versions, with a focus on validation of models, cooling need simulation,
+adaptation to other countries' datasets and building usages.
+
+Instructions on how to contribute are available at [CONTRIBUTING](CONTRIBUTING.md).
+
+
+## Open source licensing info
+1. [LICENSE](LICENSE)
+
+----
+
+## Credits and references
+BuildingModel physical models are directly derived from the work of Antoine Rogeau in [
+Vers une approche intégrée d’aide à la planification énergétique territoriale : application à la rénovation énergétique des bâtiments](https://www.theses.fr/2020UPSLM014)
+
+### Funding :
+
+### Main contributors : 
+- Antoine Rogeau
+- [Robin Girard](https://www.minesparis.psl.eu/Services/Annuaire/robin-girard) -- [gitHub](https://github.com/robingirard) [LinkedIn](https://www.linkedin.com/in/robin-girard-a88baa4/) [google Scholar](https://scholar.google.fr/citations?user=cEYGStIAAAAJ&hl=fr)
+- Seddik Yassine Abdelouadoud

buildingmodel-1.0.0/buildingmodel/__init__.py

@@ -0,0 +1,25 @@
+from importlib.resources import files
+from pathlib import Path
+
+from environs import Env
+
+# paths for bundled model-parameter data (small, committed with the package)
+# large reference data (census, diagnosis, districts, gas network) is managed
+# by the buildingdata package and no longer bundled here
+data_path = {
+    "building_statistics": files("buildingmodel") / "data" / "building_statistics",
+    "energy_use": files("buildingmodel") / "data" / "energy_use",
+    "energy_open_data": files("buildingmodel") / "data" / "energy_open_data",
+}
+
+
+# environ file variable
+# Load environment file
+BASE_DIR = Path(__file__).parent.expanduser().resolve()
+log_dir = BASE_DIR / "logs"
+environ_path = BASE_DIR / ".env"
+env = Env()
+Env.read_env(environ_path)
+
+# display plots in tests
+plot = env.bool("plot", False)