https://github.com/thegridelectric/gridworks-timecoordinator

GridWorks simulated time actor in Python
https://github.com/thegridelectric/gridworks-timecoordinator

grid-simulation transactive-energy

Last synced: 5 months ago
JSON representation

GridWorks simulated time actor in Python

• Host: GitHub
• URL: https://github.com/thegridelectric/gridworks-timecoordinator
• Owner: thegridelectric
• License: mit
• Created: 2022-11-08T17:49:29.000Z (over 3 years ago)
• Default Branch: dev
• Last Pushed: 2023-06-05T16:43:13.000Z (about 3 years ago)
• Last Synced: 2024-01-27T19:37:38.909Z (over 2 years ago)
• Topics: grid-simulation, transactive-energy
• Language: Python
• Homepage:
• Size: 804 KB
• Stars: 0
• Watchers: 6
• Forks: 0
• Open Issues: 15
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

          
# Gridworks Timecoordinator

[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)][pre-commit]

[![Black](https://img.shields.io/badge/code%20style-black-000000.svg)][black]

[pre-commit]: https://github.com/pre-commit/pre-commit

[black]: https://github.com/psf/black

The TimeCoordinator is a GNode Actor in a larger Transactive Energy Management (TEM) system. It is responsible for managing time in simulations of transactive devices interacting with the electric grid. It is one of the docker instances in the [GNodeFactory demo](https://github.com/thegridelectric/g-node-factory).

## Sketch of its role

![alt_text](docs/img/tc-graphic-1.png)

![alt_text](docs/img/tc-graphic-2.png)

![alt_text](docs/img/tc-graphic-3.png)

## Development

1. Set up python envirnment

   ```

   poetry install

   poetry shell

   ```

2. Install [docker](https://docs.docker.com/get-docker/)

3. Start docker containers

- **X86 CPU**:

  ```

  docker compose -f world-rabbit-x86.yml up -d

  ```

- **arm CPU**:

  ```

  docker compose -f world-rabbit-arm.yml up -d

  ```

4. Check rabbit on its console at [http://0.0.0.0:15672/#/](http://0.0.0.0:15672/#/)

   - username/password are both

     ```

     smqPublic

     ```

## Contributing

Contributions are very welcome.

To learn more, see the [Contributor Guide].

## License

Distributed under the terms of the [MIT license][license],

_Gridworks Timecoordinator_ is free and open source software.

## Credits

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

[@cjolowicz]: https://github.com/cjolowicz

[pypi]: https://pypi.org/

[hypermodern python cookiecutter]: https://github.com/cjolowicz/cookiecutter-hypermodern-python

[file an issue]: https://github.com/thegridelectric/gridworks-timecoordinator/issues

[pip]: https://pip.pypa.io/

[license]: https://github.com/thegridelectric/gridworks-timecoordinator/blob/main/LICENSE

[contributor guide]: https://github.com/thegridelectric/gridworks-timecoordinator/blob/main/CONTRIBUTING.md

[command-line reference]: https://gridworks-timecoordinator.readthedocs.io/en/latest/usage.html