The puff package is primarily a visualization-focused package aimed at offering many ways to visualize emission dispersion plumes given some site-level information (e.g., wind conditions, emission rate, etc.).
Though focused on visualization, puff also provides functions for simulating and running the Gaussian puff model in either sensor or grid mode. Sensor mode corresponds to running the model based on specific sensor locations, where as grid mode corresponds to running the model across a full site. See the paper or the Python version for more model-specific details.
Stable (on CRAN):
install.packages("puff")
library(puff)
Dev:
devtools::install_github("Hammerling-Research-Group/puff")
Once the user obtains output from the forward model (either via the puff package (simulate_sensor_mode() or simulate_grid_mode()) or via some other approach), they can use their site details and concentration output to build numerous visualizations, including several static plots, 2D and 3D animated plots, and a site map generator based on sensor and source coordinates.
Please start with the package vignette for more details on getting started.
This software is being actively developed, with more features and updates forthcoming. Wide engagement with it and collaboration is welcomed!
Please note that before contributing, first read and abide by our group's Code of Conduct. Then, review and abide by our group's workflow and Standards of Development.
When you're ready, here are the best ways to contribute:
-
Submit an issue reporting a bug, requesting a feature enhancement, etc.
-
Suggest changes directly via a pull request
-
Reach out directly here or here with ideas if you're uneasy with public interaction