puff

Production code for visualizing the Gaussian puff atmospheric model in R

https://github.com/hammerling-research-group/puff

Science Score: 26.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (17.1%) to scientific vocabulary

Keywords

atmospheric-model dlq emissions gaussian oil-and-gas r sensors
Last synced: 9 months ago · JSON representation

Repository

Production code for visualizing the Gaussian puff atmospheric model in R

Basic Info
Statistics
  • Stars: 1
  • Watchers: 2
  • Forks: 1
  • Open Issues: 0
  • Releases: 1
Topics
atmospheric-model dlq emissions gaussian oil-and-gas r sensors
Created over 1 year ago · Last pushed about 1 year ago
Metadata Files
Readme License

README.md

Visualizing the Gaussian Puff Atmospheric Model

Project Status: Active – The project has reached a stable, usable state and is being actively developed. CRAN_Status_Badge CI lint CI tests GitHub contributors

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.

Installation and Usage

Stable (on CRAN):

```{r} install.packages("puff")

library(puff) ```

Dev:

{r} 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.

Contribute

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

Owner

  • Name: Hammerling Research Group
  • Login: Hammerling-Research-Group
  • Kind: organization
  • Email: hammerling@mines.edu
  • Location: Golden, CO

An Applied Mathematics and Statistics Research Lab at the Colorado School of Mines

GitHub Events

Total
  • Create event: 13
  • Release event: 1
  • Issues event: 3
  • Watch event: 1
  • Delete event: 4
  • Issue comment event: 1
  • Public event: 1
  • Push event: 103
  • Pull request review comment event: 3
  • Pull request event: 17
  • Pull request review event: 10
  • Fork event: 1
Last Year
  • Create event: 13
  • Release event: 1
  • Issues event: 3
  • Watch event: 1
  • Delete event: 4
  • Issue comment event: 1
  • Public event: 1
  • Push event: 103
  • Pull request review comment event: 3
  • Pull request event: 17
  • Pull request review event: 10
  • Fork event: 1

Issues and Pull Requests

Last synced: 9 months ago

All Time
  • Total issues: 10
  • Total pull requests: 36
  • Average time to close issues: 25 days
  • Average time to close pull requests: about 18 hours
  • Total issue authors: 1
  • Total pull request authors: 2
  • Average comments per issue: 0.2
  • Average comments per pull request: 0.11
  • Merged pull requests: 32
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 10
  • Pull requests: 36
  • Average time to close issues: 25 days
  • Average time to close pull requests: about 18 hours
  • Issue authors: 1
  • Pull request authors: 2
  • Average comments per issue: 0.2
  • Average comments per pull request: 0.11
  • Merged pull requests: 32
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • pdwaggoner (10)
Pull Request Authors
  • teaganward (22)
  • pdwaggoner (13)
Top Labels
Issue Labels
enhancement (1) documentation (1)
Pull Request Labels

Packages

  • Total packages: 1
  • Total downloads:
    • cran 164 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 0
  • Total versions: 1
  • Total maintainers: 1
cran.r-project.org: puff

Simulate and Visualize the Gaussian Puff Forward Atmospheric Model

  • Versions: 1
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 164 Last month
Rankings
Dependent packages count: 26.8%
Dependent repos count: 33.0%
Average: 48.8%
Downloads: 86.7%
Maintainers (1)
Last synced: 9 months ago

Dependencies

.github/workflows/r.yml actions
  • actions/checkout v4 composite
  • r-lib/actions/setup-r f57f1301a053485946083d7a45022b278929a78a composite
DESCRIPTION cran