ebm 0.99.3__py3-none-any.whl

ebm-0.99.3.dist-info/METADATA

@@ -0,0 +1,217 @@
+Metadata-Version: 2.4
+Name: ebm
+Version: 0.99.3
+Summary: A project for energy usage modeling
+Author-email: Lars Petrusson <lfep@nve.no>, Ketil Nordstad <kenord@nve.no>
+Project-URL: Homepage, https://www.nve.no/
+Project-URL: Documentation, https://nve.github.io/ebm-docs
+Project-URL: Repository, https://github.com/NVE/ebm
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: loguru
+Requires-Dist: numpy
+Requires-Dist: openpyxl
+Requires-Dist: pandas
+Requires-Dist: python-dotenv
+Requires-Dist: rich
+Requires-Dist: pandera
+Requires-Dist: XlsxWriter
+Requires-Dist: pywin32; platform_system == "Windows"
+Provides-Extra: test
+Requires-Dist: pytest; extra == "test"
+Provides-Extra: build
+Requires-Dist: build; extra == "build"
+Provides-Extra: dev
+Requires-Dist: ebm[test]; extra == "dev"
+Requires-Dist: ebm[build]; extra == "dev"
+Requires-Dist: ruff; extra == "dev"
+Requires-Dist: ruff-lsp; extra == "dev"
+Provides-Extra: docs
+Requires-Dist: sphinx; extra == "docs"
+Requires-Dist: sphinx-rtd-theme; extra == "docs"
+Requires-Dist: sphinx-autodoc-typehints; extra == "docs"
+Requires-Dist: numpydoc; extra == "docs"
+Requires-Dist: sphinx-tabs; extra == "docs"
+Provides-Extra: tqdm
+Requires-Dist: tqdm; extra == "tqdm"
+Requires-Dist: XlsxWriter; extra == "tqdm"
+Dynamic: license-file
+
+#  Introduction 
+
+EBM is a model used by the Norwegian Water Resources and Energy Directorates (NVE) to forecast energy use in the 
+building stock. EBM is an open-source model developed and managed by NVE. The model allows the user to analyze how 
+demographic trends and policy instruments impact the yearly energy use on a national and regional level. Energy use is 
+estimated by a bottom- up approach, based on the building stock floor area, energy need and distribution of heating 
+systems. The mathematical model is implemented in Python, with input and output files in excel or csv.
+
+
+![ebm-in-windows-terminal.png](docs/source/_static/getting_started/ebm-in-windows-terminal.png)
+
+
+# Getting Started
+
+## More information
+
+
+ - [Full documentation found here](https://nve.github.io/ebm-docs/index.html)
+   - [Model description](https://nve.github.io/ebm-docs/model_description/index.html)
+   - [Limitations](https://nve.github.io/ebm-docs/limitations.html)
+   - [Getting started](https://nve.github.io/ebm-docs/user_guide/getting_started.html)
+   - [Troubleshooting](https://nve.github.io/ebm-docs/user_guide/troubleshooting.html)
+
+
+## 1. Installation process
+
+Please refer to [getting started](https://nve.github.io/ebm-docs/user_guide/getting_started.html) for information on 
+how ti install EBM as a user. 
+
+Open a terminal application and navigate to wherever you want to do work. 
+
+### Make a python virtual environment (optional)
+
+While optional, it is always recommended to install and run python modules in a discrete virtual environment. To create a 
+new python virtual environment (venv) type the following in a terminal.
+
+ `python -m venv venv`
+
+## Activate virtual environment
+To use your venv you need to activate it
+### Using powershell
+(Your command prompt starts with PS) 
+`\venv\Scripts\active.ps1`
+
+### Using cmd
+(Your command prompt starts with C:\ where C is any letter from A-Z)
+`\venv\Scripts\active.bat`
+
+### GNU/Linux and macOS
+
+`source venv/bin/active`
+
+More information on [Python virtual environments](https://realpython.com/python-virtual-environments-a-primer/)
+
+
+## Install EBM
+
+There are two options. **Install from PyPI** (Python package index) or install **clone the github repository**.
+
+### Install from PyPI
+
+`python -m pip install ebm`
+
+You can now run the model as a module `python -m ebm` or as a program `ebm`
+
+Please refer to [getting started](https://nve.github.io/ebm-docs/user_guide/getting_started.html) for more information on how the model works.
+
+
+### Clone the github repository
+
+`git clone https://github.com/NVE/ebm`
+
+`cd ebm`
+
+Make sure your current working directory is the EBM root. 
+
+```
+python -m pip install -e .
+
+```
+
+The command will install install all dependencies and ebm as an editable module.
+
+    
+    
+## 2. Software dependencies
+  - pandas
+  - loguru
+  - openpyxl
+  - pandera
+   
+  Dependecies will be automatically installed when you install the package as described under Installation process.
+  See also [requirements.txt](requirements.txt)
+
+## 3. Run the model
+
+There are multiple ways to run the program. Listed bellow is running as a standalone program and running as a module. If 
+running as a program fails due to security restriction, you might be able to use the module approach instead. 
+
+See also [Running as code](#running-as-code)
+
+
+### Running as a module
+
+```cmd
+python3 -m ebm
+```
+
+By default, the results will be written to the subdirectory `output`
+
+For more information use `--help`
+
+`python -m ebm --help`
+
+```shell
+usage: ebm [-h] [--version] [--debug] [--categories [CATEGORIES ...]] [--input [INPUT]] [--force] [--open]
+           [--csv-delimiter CSV_DELIMITER] [--create-input] [--horizontal-years]
+           [{area-forecast,energy-requirements,heating-systems,energy-use}] [output_file]
+
+Calculate EBM energy use 1.2.15
+
+positional arguments:
+  {area-forecast,energy-requirements,heating-systems,energy-use}
+
+                        The calculation step you want to run. The steps are sequential. Any prerequisite to the chosen step will run
+                            automatically.
+  output_file           The location of the file you want to be written. default: output\ebm_output.xlsx
+                            If the file already exists the program will terminate without overwriting.
+                            Use "-" to output to the console instead
+
+options:
+  -h, --help            show this help message and exit
+  --version, -v         show program's version number and exit
+  --debug               Run in debug mode. (Extra information written to stdout)
+  --categories [CATEGORIES ...], --building-categories [CATEGORIES ...], -c [CATEGORIES ...]
+
+                        One or more of the following building categories:
+                            house, apartment_block, kindergarten, school, university, office, retail, hotel, hospital, nursing_home, culture, sports, storage_repairs.
+                            The default is to use all categories.
+  --input [INPUT], --input-directory [INPUT], -i [INPUT]
+                        path to the directory with input files
+  --force, -f           Write to <filename> even if it already exists
+  --open, -o            Open output file(s) automatically when finished writing. (Usually Excel)
+  --csv-delimiter CSV_DELIMITER, --delimiter CSV_DELIMITER, -e CSV_DELIMITER
+                        A single character to be used for separating columns when writing csv. Default: "," Special characters like ; should be quoted ";"
+  --create-input
+                        Create input directory containing all required files in the current working directory
+  --horizontal-years, --horizontal, --horisontal
+                        Show years horizontal (left to right)
+```
+
+
+### Running as code
+```python
+
+from ebm.temp_calc import calculate_energy_use_wide
+from ebm.model.file_handler import FileHandler
+
+fh = FileHandler()
+fh.create_missing_input_files()
+
+df = calculate_energy_use_wide(ebm_input=fh.input_directory)
+print(df)
+
+```
+
+## License
+This project is licensed under the MIT License. You are free to use, modify, and distribute the software with proper attribution.
+
+## Contributing
+We welcome contributions! Please refer to the Contributing Guide (CONTRIBUTING.md) for details on how to get started.
+
+## Documentation
+Full documentation is available at the EBM User Guide: https://nve.github.io/ebm/
+
+
+

ebm-0.99.3.dist-info/RECORD

@@ -0,0 +1,80 @@
+ebm/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+ebm/__main__.py,sha256=36siuK2lKFMhECFMKcdhIU6Az5s7ryUHr0ABUf4HaxU,6515
+ebm/__version__.py,sha256=oXdI5y4E3p_GhsC6lq1Vw8Nijt6C-imp2BTCgin1S5g,20
+ebm/energy_consumption.py,sha256=zf1FHat3sGNZHi4N2Pe4FHIgda_arNoP_rcVwPSERIU,16582
+ebm/extractors.py,sha256=cwYyqV_mzKPF0O7FlKifKNUbCKIJz0wn4qOoLW4NPwE,5123
+ebm/heating_system_forecast.py,sha256=c4zGqHYLtV6bJqGHmY1H78FvC32C8OleE72gd9UE4yk,22929
+ebm/holiday_home_energy.py,sha256=-mglnBrkrPG1s_cSS6qqXSwVfsZRQ21QztuRajy4HKI,14667
+ebm/migrations.py,sha256=3QXijoaAQpAhn0WxU3If0-wQe3cOM28vWQLQvaG8DBc,7931
+ebm/s_curve.py,sha256=s3kFSQHQimdz_T8CToYH-fDgi5EWWClLZJs1DeLj41Y,20376
+ebm/temp_calc.py,sha256=aPn4JG8PiBWROGlLb7ugfViGDZOZ_zarZxtvH8F3AO8,4940
+ebm/validators.py,sha256=XQruv7pF7Vpm-oOw62cn7totA6lH0jGlCZaS2tKhSJw,22582
+ebm/cmd/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+ebm/cmd/calibrate.py,sha256=_E59K371wNKthEKDMW4x8DsmphYNZ5RqG4ReXAN6Lww,3097
+ebm/cmd/calibrate_excel_com_io.py,sha256=npivvLC5i5SkmrwFlmXMrwarYfxd4agfrV3q50hGV9c,6407
+ebm/cmd/heating_systems_by_year.py,sha256=0eElYkhvnJAen7p9Y_WvQyGuXUvDlxLFjt5zcC_adDw,740
+ebm/cmd/helpers.py,sha256=-zjOOPb17VeAJ1N6E2YtnabNcFqE0iVwoaUggZeXbIw,5398
+ebm/cmd/initialize.py,sha256=uJjXGbP71VPLnDWNohfO4bJidM3c00vI-1xknXmrOyE,5609
+ebm/cmd/migrate.py,sha256=wtpuTu0DcHNzTC9wZUgNiJ-rTSW-e6lYpRVdi-lBgW0,2819
+ebm/cmd/pipeline.py,sha256=0LhmL_vgKEuUvz_p46VQREjKkh8a6k-bUzAtSQcsWvo,11438
+ebm/cmd/prepare_main.py,sha256=0ovruHbUvnkIOUNQoPKeio7DGtA9Ip7ZfTnCEoWnps0,7563
+ebm/cmd/result_handler.py,sha256=A1rMd4llD1PezH07E5-Ooz2NBTkcAzgAQHGTFRBcW9M,12358
+ebm/cmd/run_calculation.py,sha256=HrezG48SPpGpigFiAQ393aIsdRFXW9598sJktLQsu3k,8274
+ebm/data/area.csv,sha256=KoPtsmP0qMIbJFHLgIhrWSKlmq9y-MYtxpiIrXGqQCs,2475
+ebm/data/area_new_residential_buildings.csv,sha256=hUnVbXnWKMV-7R_5D8cBof6tssRxNTBzCTsz4ihj8Zs,76
+ebm/data/area_per_person.csv,sha256=9qYHBnMwmeoRB9oKJnSRWiE6tuL52RSH4Ma80Nttijo,192
+ebm/data/building_code_parameters.csv,sha256=1rBHY8QHMjL0IfCv2OP18sduim5MjBfq8tH88mOENR4,238
+ebm/data/energy_need_behaviour_factor.csv,sha256=J-s_zUYPTs53XETnaw-_wbT8EZbKYpdp0W0PF89VnKo,305
+ebm/data/energy_need_improvements.csv,sha256=ZqEZUloIKjcKgZnZZgQMnF2gqNfGdCl0jDCLeGGEigM,462
+ebm/data/energy_need_original_condition.csv,sha256=uUPEJbVBHeKTx1Tl3v5yInnQ7buhwYaP10_k6fTjjnM,23191
+ebm/data/heating_system_efficiencies.csv,sha256=Fyix3PKOds9ByQITj5hAflO-TAGs3gcoUZpikuj44CU,1340
+ebm/data/heating_system_forecast.csv,sha256=8eninSFqzYJaM6ITF2J-hytXDg9T9hSCjyCw33RKfH4,1847
+ebm/data/heating_system_initial_shares.csv,sha256=sqX-EJjHTSAxAOd-SESUto-Dxqdq9f_RRoLQ3bokxFU,67093
+ebm/data/holiday_home_energy_consumption.csv,sha256=v8xU3L_bEksVuBtqMJsQ4HgDTk2KFLtfSo4CyTY41Ng,446
+ebm/data/holiday_home_stock.csv,sha256=euPZGWseenOQNQj5705v17J9LlunIfdo3pj2v7WxLIE,652
+ebm/data/improvement_building_upgrade.csv,sha256=CskzmpU2NGhu53l09nzuxeGwpSX8TAcuU1GUnxoL4Vs,475
+ebm/data/new_buildings_residential.csv,sha256=ikxLmAGzK6PcLB8xzPIGWIelNHEs2si--YV58iSFBpc,1807
+ebm/data/population_forecast.csv,sha256=uYmQAEeB16SVJmY2jGXz9Xxtit45CNenMcvRs1vnFG8,959
+ebm/data/s_curve.csv,sha256=xNP4c6PzX6PfM-VP8voRXXohsJD8mJKNLSSqb-vEiRA,1854
+ebm/model/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+ebm/model/area.py,sha256=jW9YChz9nmqKO6pwXuGZ_uh5B6aP2l0jeuDsmusc6w0,18712
+ebm/model/bema.py,sha256=29oUjgkMpQzfkkqy3E2dQVZCBNfqNvn5hg-8ty5W-XY,6863
+ebm/model/building_category.py,sha256=-sg-lDHXgjy3AytbZcKJJAnaqqMAKU_8s3hP9s59hbE,5408
+ebm/model/building_condition.py,sha256=S5gbvsskxhTwD4BG8kOD74uN6G-XZN6IEuamvrI7Nno,2697
+ebm/model/calibrate_energy_requirements.py,sha256=4FA3NiOQ6w2gGc6lSzyWaQngBGuxbM93XmZXBX5yH1E,2688
+ebm/model/calibrate_heating_systems.py,sha256=fGe99Llt0ddzaRcBHPZ4pG6ixM_zdAzxbmnUTawguhU,7703
+ebm/model/column_operations.py,sha256=-hxVI7gahl2JOxmXMSmQcPy3VYpKNxWkg63Ecc3yTj8,6503
+ebm/model/construction.py,sha256=t8SynZvcHj7BSQK4ZLO7wWeI9HK061Dg-1ztnYmFuz8,39906
+ebm/model/data_classes.py,sha256=bW82BKUSvVzspUyEov_OCmLtYKoPrgcPdYDORXZ6KzI,6754
+ebm/model/database_manager.py,sha256=uU_NyuZBFwR-HB4Hpng2xE2QWA7TQ1V3rQ5N4QCOi98,17658
+ebm/model/dataframemodels.py,sha256=I1_ZAVp6ui7jJMDvsOs3jLN-k5jOvTCBUG4SFqhqxZ0,4959
+ebm/model/defaults.py,sha256=m4isGbcMSZv9BrOb01uRhEi-U8mqiyhPE_3oDludT0g,768
+ebm/model/energy_need.py,sha256=aZAKml1-TSKqFT9Z-gMoxE_2lMFJ14aCZvbletpwzg8,473
+ebm/model/energy_need_filter.py,sha256=jZ7E1wLfOTPrbkMSSNndS2R4NJNqb5WZArUPCQWIgQ4,7028
+ebm/model/energy_purpose.py,sha256=B_Et8uRIVOAohsjq7fm-uL-wQjXmLEiRN1hyr9EsZLg,4715
+ebm/model/energy_requirement.py,sha256=kZvuPLH49uflqtBtaEXDCp222PDDrPoNME7mamhu0a0,18148
+ebm/model/energy_use.py,sha256=IUJWyjO3gyDs_zcZvCuV7GTqRlLaYbl37kprJs6xFVk,10377
+ebm/model/enums.py,sha256=Ru7XVm12f1dXdNEevqyTnfldWXzqE9Ss9eRshfNj9rQ,191
+ebm/model/exceptions.py,sha256=UtK6iRiJV_PjqClfFwkn8_COiw2tRlBnUDtTwHb7VDU,117
+ebm/model/file_handler.py,sha256=-a9DyRdC9i92oXrhss56JfFRU0gDjaDMKcFjX6dluqY,15245
+ebm/model/filter_scurve_params.py,sha256=5mIFBZ7Fw0JqKrmTDhW_fLx8uPlPtLP371N1ZsozkL0,4389
+ebm/model/filter_tek.py,sha256=jvWS3hgT72riAi84KJ2nnN0GU29FCEQpngZOXhU2Yuo,7220
+ebm/model/heat_pump.py,sha256=eaCgj-77q5qX1vq_f84VCl5iKxCTKwAhh0RVusdTZWo,2397
+ebm/model/heating_systems.py,sha256=ql_hSrknfgb7QremgJUs7_eEqlkhZSYfAlFnDKH2ZmE,677
+ebm/model/heating_systems_parameter.py,sha256=ElenZcEqSxY4bCS57sGd3A4-gQe8nx6-b0QzJHCJV84,646
+ebm/model/heating_systems_projection.py,sha256=rqUtJyMLicobcyhmr74TepjmUQAEmlazKT3vjV_n3aA,6
+ebm/model/heating_systems_share.py,sha256=QROuT5f0ueRvkEwTklPNckr6HgVcHrYM43YvVel5iQU,1292
+ebm/model/scurve.py,sha256=3zJfdnXRr44G0oF6uJqhyeF8_BE3a02GqEL9JDScvEs,8873
+ebm/model/tek.py,sha256=frcCV1k9oG9oKj3dpUqdJg1PxRT2RSN_XKdLCPjaYaY,2
+ebm/services/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+ebm/services/calibration_writer.py,sha256=Vqnl8J7Qd6IudfkIdXFQPljsnBA-ZvrWEX37DB1c4Ns,10591
+ebm/services/console.py,sha256=pxYTCBU2P2XGvDhf8m6JW4z4ACQClOIpcZtY-JI7hoY,3611
+ebm/services/excel_loader.py,sha256=4wA1NwpVhjbbPHYzd8ff-3Y0Qiue3bs8Wi9AiToxo6c,2315
+ebm/services/files.py,sha256=z5dACO7kLgfmZsVlVqcBJB7lBLFsE60r7yV1qm_0u5Q,1247
+ebm/services/spreadsheet.py,sha256=ULeW9OGkzHILyDcj4CVFaT4jq3PdjAOrgW-IgmcatK4,10400
+ebm-0.99.3.dist-info/licenses/LICENSE,sha256=z6m_5UiYKx1WqLe3n_p0-r8qmnI-EB6A742-bBjrnL0,1115
+ebm-0.99.3.dist-info/METADATA,sha256=XeE69Za3_0n7III6kcaUaDmNup8CYdxvSh8A-dc5_mo,7914
+ebm-0.99.3.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+ebm-0.99.3.dist-info/entry_points.txt,sha256=oBnI63ekBLrYuADfsoXaM2_frfTvqv0YFpyIdOOMp6g,94
+ebm-0.99.3.dist-info/top_level.txt,sha256=gPNbfZiBvhzVrSAsrzR_rJbhjXGgR_3po5621JZvdds,4
+ebm-0.99.3.dist-info/RECORD,,

ebm-0.99.3.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (80.9.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

ebm-0.99.3.dist-info/entry_points.txt

@@ -0,0 +1,3 @@
+[console_scripts]
+ebm = ebm.__main__:main
+ebm-calibrate = ebm.cmd.calibrate_excel_com_io:main

ebm-0.99.3.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Norges vassdrags- og energidirektorat
+
+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.

ebm-0.99.3.dist-info/top_level.txt

@@ -0,0 +1 @@
+ebm