Opensynth is a library forsynthetic energy demand generation.
Project description
OpenSynth
OpenSynth Model Repository.
💻 Development Set up
To set up environment for local development, you will need to set up PyEnv and Pipenv:
Then clone this repo and run make setup
. This will set up all dependencies and precommit hooks.
Precommit Tools:
- Pytest for testing
- Mypy for type checking
- Flake8 for linting
- isort for sorting imports
- black for formatting
Available CLI apps:
pipenv run python app/app.py
for a list of Typer app commandsget-lcl-data
: Downloads, Split, Preprocesses LCL dataset.
💽 Downloading Low Carbon London dataset [1]
- The compressed version of the data from data.london.gov.uk is ~ 700Mb. The full decompressed data is about 8Gb.
- Note: LCL data was compressed with compression algorithm that doesn't work with Python's
zipfile
. You'll need to manually unzip it via command line withunzip
on Linux systems, or other equivalent on Windows machine. - You can also download the low carbon london dataset using the typer app command
pipenv run python app/app.py --download
. This will use the subprocess module to unzip the file (for linux machines). - If you're on windows, you'll need to manually download and unzip to the folder:
data/raw
ℹ️ About Low Carbon London Dataset
- Low Carbon London dataset was from a trial conducted by UK Power Networks on a representative sample of London households from 2011 to 2014.
- The dataset contains half-hourly smart meter readings of 5,567 households.
- All timestamps are given in UTC so there's no time-zone conversation needed (i.e. 48 half-hourly data a day per household)
📕 Tutorials
For tutorials on algorithms in this repository, please refer to notebooks in the notebooks
folder.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
opensynth_energy-0.0.3.tar.gz
(19.6 kB
view hashes)
Built Distribution
Close
Hashes for opensynth_energy-0.0.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 85f9139cbff73aed913e52ac3e98e43939b376f89f5a83b702eb9a6d11f6be48 |
|
MD5 | 8093ead12d03b8a441450c1dbfbb3ee1 |
|
BLAKE2b-256 | fb1c472810aaa08b1450df80e1e5d334b4d470d9c3ae05bf41f2693f7337781b |