SimFire

An open-source wildfire simulator written in Python and meant to be used to train reinforcement learning agents.
https://github.com/mitrefireline/simfire

Category: Biosphere
Sub Category: Wildfire

Keywords

python reinforcement-learning reinforcement-learning-environments simulation simulator wildfire

Keywords from Contributors

archiving measur transforms generic optimize observation compose conversion projection animals

Last synced: about 20 hours ago
JSON representation

Repository metadata

An open-source wildfire simulator written in Python and meant to be used to train reinforcement learning (RL) agents.

• Host: GitHub
• URL: https://github.com/mitrefireline/simfire
• Owner: mitrefireline
• License: apache-2.0
• Created: 2022-11-16T02:27:31.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-11-19T22:42:06.000Z (6 months ago)
• Last Synced: 2025-05-11T20:04:00.927Z (20 days ago)
• Topics: python, reinforcement-learning, reinforcement-learning-environments, simulation, simulator, wildfire
• Language: Python
• Homepage: https://mitrefireline.github.io/simfire/
• Size: 34.1 MB
• Stars: 38
• Watchers: 1
• Forks: 3
• Open Issues: 7
• Releases: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Citation: CITATION.cff

README.md

python run_game.py

from simfire.sim.simulation import FireSimulation
from simfire.utils.config import Config

config = Config("configs/operational_config.yml")
sim = FireSimulation(config)

# Run a 1 hour simulation
sim.run("1h")

# Run the same simulation for 30 more minutes
sim.run("30m")

# Render the next 2 hours of simulation
sim.rendering = True
sim.run("2h")

# Now save a GIF and fire spread graph from the last 2 hours of simulation
sim.save_gif()
sim.save_spread_graph()
# Saved to the location specified in the config: simulation.sf_home

# Update agents for display
# (x, y, agent_id)
agent_0 = (5, 5, 0)
agent_1 = (5, 5, 1)

agents = [agent_0, agent_1]

# Create the agents on the display
sim.update_agent_positions(agents)

# Loop through to move agents
for i in range(5):
    agent_0 = (5 + i, 5 + i, 0)
    agent_1 = (5 + i, 5 + i, 1)
    # Update the agent positions on the simulation
    sim.update_agent_positions([agent_0, agent_1])
    # Run for 1 update step
    sim.run(1)

# Turn off rendering so the display disappears and the simulation continues to run in the
# background
sim.rendering = False

pip install simfire

Citation (CITATION.cff)

# This CITATION.cff file was generated with cffinit.
# Visit https://bit.ly/cffinit to generate yours today!

cff-version: 1.2.0
title: SimFire
message: >-
  If you use this software, please cite it using the metadata from this file.
type: software
authors:
  - given-names: Michael
    family-names: Doyle
    email: [email protected]
    affiliation: MITRE
    orcid: 'https://orcid.org/0009-0002-0229-5693'
  - given-names: Michael
    family-names: Threet
    email: [email protected]
    affiliation: MITRE
  - given-names: Marissa
    family-names: Dotter
    email: [email protected]
    affiliation: MITRE
  - given-names: Chris
    family-names: Kempis
    email: [email protected]
    affiliation: MITRE
  - given-names: Alex
    family-names: Tapley
    email: [email protected]
    affiliation: MITRE
  - given-names: Tim
    family-names: Welsh
    email: [email protected]
    affiliation: MITRE
repository-code: 'https://github.com/mitrefireline/simfire'
url: 'https://fireline.mitre.org'
repository-artifact: 'https://pypi.org/project/simfire/'
abstract: >-
  SimFire uses PyGame to display and simulate different fire spread models, including the Rothermel Surface fire spread model.
keywords:
  - simulator
  - reinforcement learning
  - wildfire
  - fire
  - python
license: Apache-2.0
version: 2.0.1
date-released: '2024-07-08'

Owner metadata

• Name: MITRE fiReLine
• Login: mitrefireline
• Email: [email protected]
• Kind: organization
• Description:
• Website:
• Location:
• Twitter:
• Company:
• Icon url: https://avatars.githubusercontent.com/u/116850943?v=4
• Repositories: 1
• Last ynced at: 2023-04-28T05:43:31.254Z
• Profile URL: https://github.com/mitrefireline

GitHub Events

Total

• Issues event: 4
• Watch event: 9
• Delete event: 1
• Issue comment event: 3
• Push event: 3
• Pull request review event: 4
• Pull request review comment event: 2
• Pull request event: 1
• Fork event: 2
• Create event: 1

Last Year

• Issues event: 4
• Watch event: 9
• Delete event: 1
• Issue comment event: 3
• Push event: 3
• Pull request review event: 4
• Pull request review comment event: 2
• Pull request event: 1
• Fork event: 2
• Create event: 1

Committers metadata

Last synced: 4 days ago

Committer domains:

• mitre.org: 7
• mm273574-pc.lan: 1

Issue and Pull Request metadata

Last synced: 2 days ago

Package metadata

• Total packages: 1
• Total downloads:
  • pypi: 119 last-month
• Total dependent packages: 0
• Total dependent repositories: 1
• Total versions: 24
• Total maintainers: 1

Dependencies

Score: 10.905038128361106