Skip to main content
Yanked

This release has been yanked by its maintainers, and will be ignored by installers, except when explicitly specified.
Consider using release 2.0.1 instead.
Reason given by maintainers: The fire spread calculation for all versions of simfire <2.0.0 is incorrect.

SimFire Fire Simulator

Introduction

SimFire uses PyGame to display and simulate different fire spread models, including the Rothermel Surface fire spread model described in this paper.

For more comprehensive documentation, go to our docs page.

Running the Simulation


Left: Fire simulated near Julian, CA. Right: Fire simulated near Reno, NV.
Both fires have winds from the east at 20mph

Install simfire by following the installation instructions. Then run the run_game.py script:

python run_game.py

Running as a Python Module

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

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, 78, 0)
agent_1 = (80, 105, 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(60):
    # Do something here to choose the new agent locations
    agent_0 = (new_col, new_row, 0)
    agent_1 = (new_col, new_row, 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

Installing the Package

pip install simfire

Contributing

For contributing, see the Contribution Page in our docs.

Metadata

Release files for simfire 1.5.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for simfire 1.5.0
File Size Uploaded
simfire-1.5.0.tar.gz 432.7 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for simfire 1.5.0
File Interpreter ABI Platform
simfire-1.5.0-py3-none-any.whl Python 3 none any Details

Total release size: 880.8 kB

Release files / simfire-1.5.0.tar.gz

Download URL simfire-1.5.0.tar.gz
Size 432.7 kB
Tags Source
SHA-256 checksum
How to use checksums
a56b2b2c594b2348746b5b973c2ff2f1830aa4777dc8a1813bbbda376aca30f9
BLAKE2b-256 checksum
How to use checksums
c875a47546f1d396438d3c2f37f20917c10166242db4bd08525079a51100cebe
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.6.1 CPython/3.9.17 Linux/5.15.0-1041-azure

Release files / simfire-1.5.0-py3-none-any.whl

Download URL simfire-1.5.0-py3-none-any.whl
Size 448.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
ae3314408362d281b39845f7162bca79f4e74cf93a12f042e2501a21ee7df863
BLAKE2b-256 checksum
How to use checksums
0850ea8b50ccc38711df3e36d5d0ffe3e40034284dd2886250b9ca0135ed5107
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.6.1 CPython/3.9.17 Linux/5.15.0-1041-azure

Release history Release notifications | RSS feed

2.0.1

2 release files

2.0.0

2 release files

1.5.9

2 release files

1.5.8

2 release files

1.5.7

2 release files

1.5.6

2 release files

1.5.5

2 release files

1.5.4

2 release files

1.5.3

2 release files

1.5.2

2 release files

1.5.1

2 release files

This release

1.5.0 This release

2 release files

1.4.37

2 release files

1.4.36

2 release files

1.4.35

2 release files

1.4.33

2 release files

1.4.31

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page