gridworks-protocol

Gridworks Protocol


Keywords
gridworks, python, renewables, transactive-energy
License
MIT
Install
pip install gridworks-protocol==0.2.4

Documentation

GridWorks Protocol

PyPI Status Python Version License

Read the documentation at https://gridworks-protocol.readthedocs.io/ Tests Codecov

pre-commit Black

GridWorks Protocol (gwproto) is a Application Shared Language used by SCADA/AtomicTNode actor pairs to communicate with each other as they work together to manage the Service Level Agreement for transactive devices dedicated to residential thermal storage heating.

Installation

You can install Gridworks Protocol via pip from PyPI:

$ pip install gridworks-protocol

Usage

When gridworks-protocol has been included as a package:

from gwproto.types import SpaceheatNodeGt

Contributing

Contributions are very welcome. To learn more, see the Contributor Guide.

License

Distributed under the terms of the MIT license, Gridworks Protocol is free and open source software.

Issues

If you encounter any problems, please file an issue along with a detailed description.

Credits

This project was generated from @cjolowicz's Hypermodern Python Cookiecutter template.