tesp-support 1.3.7

Python APIs for the Transactive Energy Simulation Platform

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

• MATPOWER or PYPOWER for the bulk power systems

• 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:

  1. Create an account on PyPI if you haven’t yet.

  2. Install twine and build: pip install twine build

  3. Create the source distribution, change to tesp_support directory execute: python3 -m build .

  4. Check your distribution files for errors: twine check dist/*

  5. (Optional) Upload to the PyPI test server first (note: separate user registration required): twine upload –repository-url https://test.pypi.org/legacy/ dist/*

  6. 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

• Docker

• EnergyPlus

• GridLAB-D

• Matplotlib

• MATPOWER

• NetworkX

• NumPy

• Pandas

• pip

• PYPOWER

• Python

• SciPy

• TESP

Subdirectories

• tesp_support; utilities for building and running using PYPOWER with or without FNCS/HELICS co-simulations.

• test; scripts that support testing the package; not automated.

License & Copyright

• Copyright (c) 2017-2025 Battelle Memorial Institute

• See LICENSE file at https://github.com/pnnl/tesp