SustainGym
Reinforcement Learning Environments for Sustainable Energy Systems.
https://github.com/chrisyeh96/sustaingym
Category: Energy Systems
Sub Category: Energy System Modeling Frameworks
Keywords
distribution-shift energy-system reinforcement-learning
Last synced: about 11 hours ago
JSON representation
Repository metadata
Reinforcement Learning Environments for Sustainable Energy Systems
- Host: GitHub
- URL: https://github.com/chrisyeh96/sustaingym
- Owner: chrisyeh96
- License: cc-by-4.0
- Created: 2022-04-18T21:06:53.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-05-31T21:49:23.000Z (11 months ago)
- Last Synced: 2025-04-17T20:05:54.145Z (10 days ago)
- Topics: distribution-shift, energy-system, reinforcement-learning
- Language: HTML
- Homepage: https://chrisyeh96.github.io/sustaingym/
- Size: 132 MB
- Stars: 48
- Watchers: 4
- Forks: 12
- Open Issues: 3
- Releases: 3
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
README.md
SustainGym: Reinforcement Learning Environments for Sustainable Energy Systems
The lack of standardized benchmarks for reinforcement learning (RL) in sustainability applications has made it difficult to both track progress on specific domains and identify bottlenecks for researchers to focus their efforts on. We present SustainGym, a suite of environments designed to test the performance of RL algorithms on realistic sustainability tasks. These environments highlight challenges in introducing RL to real-world sustainability tasks, including physical constraints and distribution shift.
SustainGym contains both single-agent and multi-agent RL environments.
- Single-agent environments follow the Gymnasium API and are designed to be easily used with the StableBaselines3 and Ray RLLib libraries for training RL algorithms.
- Multi-agent environments follow the PettingZoo Parallel API and are designed to be easily used with the Ray RLLib library for training multi-agent RL algorithms.
Please see the SustainGym website for a getting started guide and complete documentation.
Folder structure
docs/ # website and documentation
examples/ # example code for running each environment
sustaingym/ # main Python package
algorithms/
{env}/ # per-env algorithms
data/
moer/ # marginal carbon emission rates
{env}/ # per-env data files
envs/
{env}/ # per-env modules
tests/ # unit tests
Contributing
If you would like to add a new environment, propose bug fixes, or otherwise contribute to SustainGym, please see the Contributing Guide.
License
SustainGym is released under a Creative Commons Attribution 4.0 International Public License (CC BY 4.0). See the LICENSE file for the full terms.
Citation
Please cite SustainGym as
C. Yeh, V. Li, R. Datta, J. Arroyo, N. Christianson, C. Zhang, Y. Chen, M. Hosseini, A. Golmohammadi, Y. Shi, Y. Yue, and A. Wierman, "SustainGym: A Benchmark Suite of Reinforcement Learning for Sustainability Applications," in Thirty-seventh Conference on Neural Information Processing Systems Datasets and Benchmarks Track, New Orleans, LA, USA, Dec. 2023. [Online]. Available: https://openreview.net/forum?id=vZ9tA3o3hr.
@inproceedings{yeh2023sustaingym,
title = {{SustainGym}: Reinforcement Learning Environments for Sustainable Energy Systems},
author = {Yeh, Christopher and Li, Victor and Datta, Rajeev and Arroyo, Julio and Zhang, Chi and Chen, Yize and Hosseini, Mehdi and Golmohammadi, Azarang and Shi, Yuanyuan and Yue, Yisong and Wierman, Adam},
year = 2023,
month = 12,
booktitle = {Thirty-seventh Conference on Neural Information Processing Systems Datasets and Benchmarks Track},
address = {New Orleans, LA, USA},
url = {https://openreview.net/forum?id=vZ9tA3o3hr}
}
An earlier version of this work was published as a workshop paper:
C. Yeh, V. Li, R. Datta, Y. Yue, and A. Wierman, "SustainGym: A Benchmark Suite of Reinforcement Learning for Sustainability Applications," in NeurIPS 2022 Workshop on Tackling Climate Change with Machine Learning, Dec. 2022. [Online]. Available: https://www.climatechange.ai/papers/neurips2022/38.
@inproceedings{yeh2022sustaingym,
title = {{SustainGym}: A Benchmark Suite of Reinforcement Learning for Sustainability Applications},
author = {Yeh, Christopher and Li, Victor and Datta, Rajeev and Yue, Yisong and Wierman, Adam},
year = 2022,
month = 12,
booktitle = {NeurIPS 2022 Workshop on Tackling Climate Change with Machine Learning},
address = {New Orleans, LA, USA},
url = {https://www.climatechange.ai/papers/neurips2022/38}
}
Owner metadata
- Name: Christopher Yeh
- Login: chrisyeh96
- Email:
- Kind: user
- Description:
- Website:
- Location:
- Twitter:
- Company:
- Icon url: https://avatars.githubusercontent.com/u/7686641?u=c545f6d92aa772c6e194cd792f2f47522bbb7b66&v=4
- Repositories: 11
- Last ynced at: 2023-02-27T10:40:40.768Z
- Profile URL: https://github.com/chrisyeh96
GitHub Events
Total
- Watch event: 10
- Fork event: 3
Last Year
- Watch event: 10
- Fork event: 3
Committers metadata
Last synced: 6 days ago
Total Commits: 90
Total Committers: 5
Avg Commits per committer: 18.0
Development Distribution Score (DDS): 0.233
Commits in past year: 4
Committers in past year: 2
Avg Commits per committer in past year: 2.0
Development Distribution Score (DDS) in past year: 0.25
Name | Commits | |
---|---|---|
Christopher Yeh | c****6 | 69 |
Ethan Wilk | e****k@g****m | 17 |
Chi Zhang | 9****6 | 2 |
liv20 | 5****0 | 1 |
Nico Christianson | n****n@g****m | 1 |
Committer domains:
Issue and Pull Request metadata
Last synced: 1 day ago
Total issues: 1
Total pull requests: 25
Average time to close issues: N/A
Average time to close pull requests: 29 days
Total issue authors: 1
Total pull request authors: 7
Average comments per issue: 0.0
Average comments per pull request: 0.28
Merged pull request: 17
Bot issues: 0
Bot pull requests: 0
Past year issues: 0
Past year pull requests: 1
Past year average time to close issues: N/A
Past year average time to close pull requests: 1 day
Past year issue authors: 0
Past year pull request authors: 1
Past year average comments per issue: 0
Past year average comments per pull request: 0.0
Past year merged pull request: 1
Past year bot issues: 0
Past year bot pull requests: 0
Top Issue Authors
- Swathii-CP (1)
Top Pull Request Authors
- chrisyeh96 (8)
- chz056 (6)
- ewilk0 (3)
- rajeev-datta (3)
- liv20 (3)
- chennnnnyize (1)
- nhchristianson (1)
Top Issue Labels
Top Pull Request Labels
Package metadata
- Total packages: 1
-
Total downloads:
- pypi: 527 last-month
- Total dependent packages: 0
- Total dependent repositories: 0
- Total versions: 8
- Total maintainers: 1
pypi.org: sustaingym
SustainGym: Reinforcement Learning Environments for Sustainable Energy Systems
- Homepage: https://chrisyeh96.github.io/sustaingym/
- Documentation: https://sustaingym.readthedocs.io/
- Licenses: CC BY 4.0
- Latest release: 0.1.7 (published 11 months ago)
- Last Synced: 2025-04-26T11:32:30.676Z (1 day ago)
- Versions: 8
- Dependent Packages: 0
- Dependent Repositories: 0
- Downloads: 527 Last month
-
Rankings:
- Dependent packages count: 7.412%
- Forks count: 19.27%
- Stargazers count: 23.186%
- Average: 29.756%
- Dependent repos count: 69.155%
- Maintainers (1)
Score: 11.810359828864687