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.4
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| simfire-1.5.4.tar.gz | 433.1 kB | Without provenance | Details for simfire-1.5.4.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| simfire-1.5.4-py3-none-any.whl | Python 3 | none | any | Details for simfire-1.5.4-py3-none-any.whl |
Total release size: 881.5 kB
Release files / simfire-1.5.4.tar.gz
| Download URL | simfire-1.5.4.tar.gz |
|---|---|
| Size | 433.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
1f7c4cbf47ca6db77af003fa6258a3d17541c45816f6593c6f2eae5a3fb5df95
|
|
BLAKE2b-256 checksum How to use checksums |
efd46c0c6c81beccc7c70b99affce18ebf7e9faff0f8c207296481727901e93b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.6.1 CPython/3.9.18 Linux/6.2.0-1011-azure
|
Release files / simfire-1.5.4-py3-none-any.whl
| Download URL | simfire-1.5.4-py3-none-any.whl |
|---|---|
| Size | 448.4 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
3496e2c9a75db8f72b7c76c0775303957d5b36bbc1609d9c6daa11e8690ce676
|
|
BLAKE2b-256 checksum How to use checksums |
230f9b0cb5bb2ccb0b4fcf536ffde923d87beab51c7a8e3d233419fbf5cb8a41
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.6.1 CPython/3.9.18 Linux/6.2.0-1011-azure
|
Security for simfire 1.5.4
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.