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.

RabbitMQ Infrastructure

All GridWorks repos require a running rabbitMQ dev broker running to pass tests or run dev simulations. Instructions for setting it up:

  • Make sure you have docker installed
  • Know whether your computer architecture is x86 or arm
  • Start the dev broker in a docker container:
    • x86 architecture: ./x86.sh
    • arm architecture: ./arm.sh
  • Tests for success:
    1. go to http://0.0.0.0:15672/ - it should look like this:

alt_text 2) pytest tests should all passs

Username/password for the dev rabbit broker: smqPublic/smqPublic

The Gridworks broker page has more information on the GridWorks brokers and how to use them for troubleshooting,

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.1.0.tar.gz (14.4 kB view details)

Uploaded Source

Built Distribution

gridworks-1.1.0-py3-none-any.whl (16.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: gridworks-1.1.0.tar.gz
  • Upload date:
  • Size: 14.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.9

File hashes

Hashes for gridworks-1.1.0.tar.gz
Algorithm Hash digest
SHA256 130d803769f87e3752d283d72c54293b84ad4f058426e013fbce75fdec7ba795
MD5 5269b4954045b62a63039ab7a6141c09
BLAKE2b-256 e007e89e013a0c8c40a40a0675ac6de1a20c66bf635243de06b974aa9f5dc9a4

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: gridworks-1.1.0-py3-none-any.whl
  • Upload date:
  • Size: 16.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.9

File hashes

Hashes for gridworks-1.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 75b50357216bd979e4863e017c1149af37954f7a69234e1f6a1d9819354d68d5
MD5 341abd3a88f00f262e0286d5f64a8927
BLAKE2b-256 160995df838278f43724d48286659b9d9c6bf9a357d03424fdaea028b61518c3

See more details on using hashes here.

Provenance

Supported by

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