energydatamodel

(★ 93)

🔋 Represent energy systems as Python data classes for improved modularity and readability

File Explorer

Download Latest Version (.zip)

- - publish.yml
- classes_energydatamodel.png
- logo-energydatamodel.png
- - layout.html
- - quickstart.ipynb
- class_hierarchy.rst
- conf.py
- examples.rst
- index.rst
- installation.rst
- make.bat
- Makefile
- quickstart.rst
- reference.rst
- requirements.txt
- __init__.py
- area.py
- asset.py
- bases.py
- battery.py
- building.py
- constructors.py
- containers.py
- edge.py
- element.py
- grid.py
- heatpump.py
- hydro.py
- json_io.py
- node.py
- quantities.py
- reference.py
- solar.py
- weather.py
- wind.py
- quickstart.ipynb
- __init__.py
- test_entity.py
- test_extension.py
- test_json.py
- test_reference.py
- test_tree_methods.py
.all-contributorsrc
.gitignore
.python-version
.readthedocs.yaml
build_class_explorer.py
CHANGELOG.md
LICENCE.md
pyproject.toml
README.md

# Installation Guide

1. Get the code

git clone https://github.com/rebase-energy/energydatamodel

Downloads the entire project code from GitHub to your computer.

cd energydatamodel

Moves into the project folder you just downloaded.

2. Official Install Script

Easy Recommended

Prerequisites

Python 3 Python is required to use pip.

pip install energydatamodel

Installs the package published on PyPI directly — no need to clone the source.

pip install git+https://github.com/rebase-energy/energydatamodel.git

Installs the package published on PyPI directly — no need to clone the source.

✅ After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.

Pulled directly from this repo's README.

3. Python

Easy

Prerequisites

Git Needed to download the project code from GitHub.
Python 3 On Windows, be sure to check 'Add Python to PATH' during installation.

pip install energydatamodel

Installs the package published on PyPI directly — no need to clone the source.

pip install git+https://github.com/rebase-energy/energydatamodel.git

Installs the package published on PyPI directly — no need to clone the source.

pip install -e .[dev]

Installs the Python libraries listed in requirements.txt (or similar).

✅ If it runs without errors and prints output in the terminal, it worked.

Pulled directly from this repo's README.