PyroRL
PyroRL: A Reinforcement Learning Environment for Wildfire Evacuation - Published in JOSS (2024)
Science Score: 98.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
○CITATION.cff file
-
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
✓DOI references
Found 3 DOI reference(s) in README and JOSS metadata -
✓Academic publication links
Links to: joss.theoj.org -
✓Committers with academic emails
1 of 3 committers (33.3%) from academic institutions -
✓Institutional organization owner
Organization sisl has institutional domain (sisl.stanford.edu) -
✓JOSS paper metadata
Published in Journal of Open Source Software
Repository
An RL environment made for wildfire evacuation.
Basic Info
- Host: GitHub
- Owner: sisl
- License: mit
- Language: Python
- Default Branch: master
- Homepage: https://sisl.github.io/PyroRL/
- Size: 4.6 MB
Statistics
- Stars: 18
- Watchers: 2
- Forks: 0
- Open Issues: 2
- Releases: 1
Metadata Files
README.md
██████╗ ██╗ ██╗██████╗ ██████╗ ██████╗ ██╗ ██╔══██╗╚██╗ ██╔╝██╔══██╗██╔═══██╗██╔══██╗██║ ██████╔╝ ╚████╔╝ ██████╔╝██║ ██║██████╔╝██║ ██╔═══╝ ╚██╔╝ ██╔══██╗██║ ██║██╔══██╗██║ ██║ ██║ ██║ ██║╚██████╔╝██║ ██║███████╗ ╚═╝ ╚═╝ ╚═╝ ╚═╝ ╚═════╝ ╚═╝ ╚═╝╚══════╝
PyroRL is a new reinforcement learning environment built for the simulation of wildfire evacuation. Check out the docs and the demo.
How to Use
First, install our package. Note that PyroRL requires Python version 3.8:
bash
pip install pyrorl
To use our wildfire evacuation environment, define the dimensions of your grid, where the populated areas are, the paths, and which populated areas can use which path. See an example below.
```python
Create environment
kwargs = { 'numrows': numrows, 'numcols': numcols, 'populatedareas': populatedareas, 'paths': paths, 'pathstopops': pathstopops } env = gymnasium.make('pyrorl/PyroRL-v0', **kwargs)
Run a simple loop of the environment
env.reset() for _ in range(10):
# Take action and observation
action = env.action_space.sample()
observation, reward, terminated, truncated, info = env.step(action)
# Render environment and print reward
env.render()
print("Reward: " + str(reward))
```
A compiled visualization of numerous iterations is seen below. For more examples, check out the examples/ folder.
For a more comprehensive tutorial, check out the quickstart page on our docs website.
How to Contribute
For information on how to contribute, check out our contribution guide.
Owner
- Name: Stanford Intelligent Systems Laboratory
- Login: sisl
- Kind: organization
- Location: Stanford, CA
- Website: sisl.stanford.edu
- Repositories: 236
- Profile: https://github.com/sisl
JOSS Publication
PyroRL: A Reinforcement Learning Environment for Wildfire Evacuation
Authors
Department of Computer Science, Stanford University
Department of Computer Science, Stanford University
Department of Computer Science, Stanford University
Department of Aeronautics and Astronautics, Stanford University
Editor
Michael Mahoney
Tags
python gymanisum rl wildfireGitHub Events
Total
- Issues event: 4
- Watch event: 4
- Issue comment event: 1
- Push event: 6
- Pull request event: 6
- Create event: 3
Last Year
- Issues event: 4
- Watch event: 4
- Issue comment event: 1
- Push event: 6
- Pull request event: 6
- Create event: 3
Committers
Last synced: 7 months ago
Top Committers
| Name | Commits | |
|---|---|---|
| cpondoc | c****c@c****t | 141 |
| joey-obrien | j****7@g****m | 44 |
| JosephGuman | j****g@s****u | 10 |
Committer Domains (Top 20 + Academic)
Issues and Pull Requests
Last synced: 6 months ago
All Time
- Total issues: 11
- Total pull requests: 10
- Average time to close issues: about 1 month
- Average time to close pull requests: about 23 hours
- Total issue authors: 5
- Total pull request authors: 2
- Average comments per issue: 1.36
- Average comments per pull request: 0.4
- Merged pull requests: 10
- Bot issues: 0
- Bot pull requests: 0
Past Year
- Issues: 2
- Pull requests: 6
- Average time to close issues: about 1 month
- Average time to close pull requests: 1 minute
- Issue authors: 1
- Pull request authors: 1
- Average comments per issue: 0.5
- Average comments per pull request: 0.0
- Merged pull requests: 6
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
- cpondoc (7)
- SamTov (2)
- joey-obrien (1)
- JosephGuman (1)
- shahchiragh (1)
Pull Request Authors
- cpondoc (9)
- joey-obrien (4)
Top Labels
Issue Labels
Pull Request Labels
Packages
- Total packages: 1
-
Total downloads:
- pypi 14 last-month
- Total dependent packages: 0
- Total dependent repositories: 0
- Total versions: 5
- Total maintainers: 1
pypi.org: pyrorl
An RL Environment for Wildfire Evacuation
- Homepage: https://sisl.github.io/PyroRL/
- Documentation: https://pyrorl.readthedocs.io/
- License: MIT License
-
Latest release: 1.0.1
published almost 2 years ago
Rankings
Maintainers (1)
Dependencies
- actions/checkout v4 composite
- actions/setup-python v4 composite
- codecov/codecov-action v3 composite
- actions/checkout v4 composite
- actions/upload-artifact v1 composite
- openjournals/openjournals-draft-action master composite
- actions/checkout v2 composite
- mhausenblas/mkdocs-deploy-gh-pages master composite
- numpy *
- actions/checkout v4 composite
- actions/setup-python v4 composite
- suo/flake8-github-action releases/v1 composite