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

GridWorks uses distributed actors to balance the electric grid. What does this mean? In today's world, more power comes 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. This is where GridWorks comes in. GridWorks technology enables electrical devices with some embedded storage or with flexibility to provide grid balancing. Furthermore, GridWorks allows these appliances to be more thrifty, using electricity when it is cheap and green.

To learn how using and contributing to GridWorks can support a cost-effective and rapid transition to a sustainable future:

Blockchain Mechanics

Gridworks runs markets between distributed actors acting as avatars for physical devices on the grid. It needs a foundation of trustless, secure, scalable validation and authentication. It heavily uses the Algorand blockchain. If you want to undestand more about how and why this is, go here.

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.

Usage

pip install gridworks to install the foundational package.

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

Uploaded Source

Built Distribution

gridworks-0.2.4-py3-none-any.whl (85.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: gridworks-0.2.4.tar.gz
  • Upload date:
  • Size: 58.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.11.3

File hashes

Hashes for gridworks-0.2.4.tar.gz
Algorithm Hash digest
SHA256 1d67a4781d724641f240c734c3c6b2cb16ea8d5ace2082958b384265ee4c028a
MD5 3e9a9ad8d1841e992167b2e516abb2ea
BLAKE2b-256 06876d2868f0d8ea2b266a6d4632c41bc4dc6cb46588ed2e01c1acdf8165c155

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: gridworks-0.2.4-py3-none-any.whl
  • Upload date:
  • Size: 85.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.11.3

File hashes

Hashes for gridworks-0.2.4-py3-none-any.whl
Algorithm Hash digest
SHA256 a838977a8f237f21cc92efd31a75f94ea8de99e45c73236e7cbd72600a6697e1
MD5 24a114b8cf6708c2e83b64310bb9eb91
BLAKE2b-256 f37f9873a4f7a9c8bfbd593226b582d385586ce6290de785b11b972ad42b9eda

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