PyroRL

Simulates evacuating populated areas through paths from a grid world containing wildfires.
https://github.com/sisl/pyrorl

Category: Biosphere
Sub Category: Wildfire

Last synced: about 15 hours ago
JSON representation

Repository metadata

An RL environment made for wildfire evacuation.

README.md

example workflow codecov DOI

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:

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.

# Create environment
kwargs = {
    'num_rows': num_rows,
    'num_cols': num_cols,
    'populated_areas': populated_areas,
    'paths': paths,
    'paths_to_pops': paths_to_pops
}
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.

Example Visualization of PyroRL

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 metadata


GitHub Events

Total
Last Year

Committers metadata

Last synced: 9 days ago

Total Commits: 195
Total Committers: 3
Avg Commits per committer: 65.0
Development Distribution Score (DDS): 0.277

Commits in past year: 28
Committers in past year: 2
Avg Commits per committer in past year: 14.0
Development Distribution Score (DDS) in past year: 0.464

Name Email Commits
cpondoc c****c@c****t 141
joey-obrien j****7@g****m 44
JosephGuman j****g@s****u 10

Committer domains:


Issue and Pull Request metadata

Last synced: 1 day ago

Total issues: 12
Total pull requests: 8
Average time to close issues: about 2 months
Average time to close pull requests: 1 day
Total issue authors: 5
Total pull request authors: 2
Average comments per issue: 1.58
Average comments per pull request: 0.5
Merged pull request: 8
Bot issues: 0
Bot pull requests: 0

Past year issues: 5
Past year pull requests: 4
Past year average time to close issues: 4 months
Past year average time to close pull requests: 1 minute
Past year issue authors: 3
Past year pull request authors: 1
Past year average comments per issue: 1.8
Past year average comments per pull request: 0.0
Past year merged pull request: 4
Past year bot issues: 0
Past year bot pull requests: 0

More stats: https://issues.ecosyste.ms/repositories/lookup?url=https://github.com/sisl/pyrorl

Top Issue Authors

  • cpondoc (7)
  • SamTov (2)
  • joey-obrien (1)
  • JosephGuman (1)
  • shahchiragh (1)

Top Pull Request Authors

  • cpondoc (6)
  • joey-obrien (2)

Top Issue Labels

  • testing (2)
  • enhancement (1)
  • help wanted (1)

Top Pull Request Labels


Package metadata

pypi.org: pyrorl

An RL Environment for Wildfire Evacuation

  • Homepage: https://sisl.github.io/PyroRL/
  • Documentation: https://pyrorl.readthedocs.io/
  • Licenses: MIT License
  • Latest release: 1.0.1 (published about 1 year ago)
  • Last Synced: 2025-04-29T07:01:38.265Z (1 day ago)
  • Versions: 5
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 125 Last month
  • Rankings:
    • Dependent packages count: 9.956%
    • Average: 37.836%
    • Dependent repos count: 65.716%
  • Maintainers (1)

Dependencies

.github/workflows/testing.yml actions
  • actions/checkout v4 composite
  • actions/setup-python v4 composite
  • codecov/codecov-action v3 composite
.github/workflows/draft-pdf.yml actions
  • actions/checkout v4 composite
  • actions/upload-artifact v1 composite
  • openjournals/openjournals-draft-action master composite
.github/workflows/docs.yml actions
  • actions/checkout v2 composite
  • mhausenblas/mkdocs-deploy-gh-pages master composite
pyrorl/setup.py pypi
  • numpy *
.github/workflows/lint.yml actions
  • actions/checkout v4 composite
  • actions/setup-python v4 composite
  • suo/flake8-github-action releases/v1 composite

Score: 8.879333174786028