Skip to main content

Gridworks

Project description

Gridworks

PyPI Status Python Version License

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

pre-commit Black

These days, more and more electrical power is coming from highly variable power sources such as wind and solar. And yet, the number of electrons going into the grid must match the number coming out: at every timescale, and at every geographic scale. Since the days of Tesla and Edison, this balancing job has been accomplished with central control and dispatch over hydrocarbon-burning generators.

GridWorks is a technology ecosystem inspired by the idea of a new role for electric loads on the grid. Why not design our appliances so they are alert to grid conditions, consume lots of energy when it is abundant, and can support grid balancing? This shift in the framework of how loads interact with the grid helps people receive a very specific sort of abundance: low-cost, low-carbon electricity that would otherwise go to waste.

Places to start:

  • Most GridWorks information exchange is asynchronous message passing, brokered by RabbitMQ. The first step in learning and developing is to set up a dev rabbit broker with the correct plumbing. Do this by downloading the GridWorks repository and follow the instructions below on RabbitMQ.
  • Read the Millinocket Story to understand the natural match between wind power and space heating.
  • Go through the partner Millinocket Tutorial to start understanding how GridWorks open-source technology can be used to build economics and physics tools allowing self-organized groups of people -- at many scales -- to connect the gift of low-carbon, low-cost electricity with the need of keeping people warm in the winter.

GridWorks SDKs

  • gridworks: package provides basic shared mechanics for communication and GNode structure. It is used as a package in all of our other repos.

  • gridworks-atn: package and associated documentation for the GridWorks Python AtomicTNodes SDK. AtomicTNodes are the GridWorks actors that make electrical devices transactive. This SDK is a great place to learn about blockchain mechanics, as it introduces some of the simpler structures (NFTs, stateless contracts, and then some simple stateful smart contracts constructed using beaker ) required for establishing the link between physical reality on the electric grid and the actors that play their avatars in GridWorks.

  • gridworks-marketmaker: package and associated documentation for our Python MarketMaker SDK. GridWorks uses distributed actors to balance the electric grid, and MarketMakers are the actors brokering this grid balancing via the markets they run for energy and balancing services.

There are several other open source GridWorks repos to explore on our github page, including the code running on the SCADA systems that Efficiency Maine is deploying in Millinocket this winter. The GNodeFactory currently hosts the demo, and does most of the heavy lifting in terms of identity management and authentication in GridWorks. Finally, since the demo is a distributed simulation, it needs a method of handling time. That's done by a TimeCoordinator GNode.

Contributing

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

License

Distributed under the terms of the MIT license, Gridworks 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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

gridworks-1.5.7.tar.gz (15.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

gridworks-1.5.7-py3-none-any.whl (17.8 kB view details)

Uploaded Python 3

File details

Details for the file gridworks-1.5.7.tar.gz.

File metadata

  • Download URL: gridworks-1.5.7.tar.gz
  • Upload date:
  • Size: 15.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.12

File hashes

Hashes for gridworks-1.5.7.tar.gz
Algorithm Hash digest
SHA256 cb34d984d6f001306fdf178f3f87c66870d2f1bafeba5710d309b1a1edb8c557
MD5 5130e8e4e0d92bbc808df022a809882a
BLAKE2b-256 13093558b357a0936a2a3ec85d841af7058b9be7271cbb483a705541717c37a6

See more details on using hashes here.

File details

Details for the file gridworks-1.5.7-py3-none-any.whl.

File metadata

  • Download URL: gridworks-1.5.7-py3-none-any.whl
  • Upload date:
  • Size: 17.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.12

File hashes

Hashes for gridworks-1.5.7-py3-none-any.whl
Algorithm Hash digest
SHA256 7402812666fffd31d9c6b334992f51fc9d4481b279c7a017bab04ce5742a99aa
MD5 89bd8a17e59dc3d4626a97383767d9b6
BLAKE2b-256 0fefcd1ed2c2f6a68943df9c94180b92517a863a0aafd58b076ffa778799e4e8

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page