Python support for the Transactive Energy Simulation Platform
Project description
Transactive Energy Simulation Platform (TESP) simulates the electric power distribution grid with transactive control of loads and resources. Current features include:
GridLAB-D for the distribution system and residential loads
EnergyPlus for large buildings
Bindings for transactive agents in Python, Java or C++
The goal of TESP is that researchers can focus their work on the last item, to push advances in the field.
Installation
tesp_support can be installed using pip:
$ pip install tesp_support
However, in order to be useful, tesp_support needs custom versions of GridLAB-D and EnergyPlus. It also requires Python 3.8 or later, with NumPy, SciPy, NetworkX, Matplotlib and PYPOWER. There are cross-platform installers of the complete TESP for Windows, Linux and Mac OS X on GitHub. A Docker version is also available for users.
Development Work Flow for tesp_support
From this directory, ‘pip install -e .’ points Python to this cloned repository for any calls to tesp_support functions
See the https://github.com/pnnl/tesp/tree/master/src/tesp_support/tesp_support for a roadmap of existing Python source files, and some documentation. Any changes or additions to the code need to be made in this directory.
Run tests from any other directory on this computer
When ready, edit the tesp_support version number and dependencies in setup.py
- To deploy follow the instructions in the Python Packaging Guide:
Create an account on PyPI if you haven’t yet.
Create the source distribution and wheels for your package: python setup.py sdist bdist_wheel
Install twine (or make sure you have version 2.0 or newer): pip install twine
Check your distribution files for errors: twine check dist/*
(Optional) Upload to the PyPI test server first (note: separate user registration required): twine upload –repository-url https://test.pypi.org/legacy/ dist/*
Upload to PyPI: twine upload dist/*
Any user gets the changes with ‘pip install tesp_support –upgrade’
Use ‘pip show tesp_support’ to verify the version and location on your computer
Using TESP
This is a developer’s platform for electric power grid research. See http://tesp.readthedocs.io/en/latest/ for user instructions, and http://github.com/pnnl/tesp for source code.
Links to Dependencies
Subdirectories
tesp_support; Python code for agents, configuration and post-processing.
test; scripts that support testing the package; not automated.
License & Copyright
Copyright (C) 2017-2022 Battelle Memorial Institute
Changelog
Version 1.0.0 (2017-06-08)
Initial release
Version 0.2 (2017-10-14)
For NIST TE Challenge 2
Version 0.1.4 (2018-09-30)
For GridAPPS-D Demo
GridLAB-D feature/1146 branch with FNCS-controlled switching
Version 0.1.9 (2018-12-13)
Three desktop version installers for Mac, Windows and Linux
Tutorial video
DSO+T study files
Version 0.9.2 (2020-09-11)
Support for HELICS and EnergyPlus 9.3
Bundled with ns-3 (HELICS) and opendsscmd (FNCS)
Execution on Linux or Docker
Postprocessing on Linux, Windows or Mac OS X
Version 0.9.5 (2021-03-09)
Standalone housing generator
Plot functions can save files
Case-generated SGIP1 example
Fixed the FNCS SGIP1 example
Version 1.0.1 (2021-04-23)
Updates to consensus mechanism
Balanced three-phase houses for housing generator
Remove deprecated solar and battery attributes
Update to HELICS 2.6.1
Version 1.2.0 (2022-10-3)
Added data.py to for shared data with TESP, recommended using TESP install
Added several APIs for plot GridLABD and EnergyPlus attributes
Added player server
Added DSOT agents and feeder generators
Update to HELICS 3.3.0
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
Built Distribution
Hashes for tesp_support-1.2.0-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f5880d848ed56323a8bf35c5ce2d95bf4b45b0e2231f59e3a876a450f92fe870 |
|
MD5 | 1d21de242342cf34729558097c5c6c23 |
|
BLAKE2b-256 | 2dc1bffacefead6747f1e85911269e8ce02b8bac089cda288ff7b4398ba3cc0c |