geoclaw-landspill

geoclaw-landspill: an oil land-spill and overland flow simulator for pipeline rupture events - Published in JOSS (2021)

https://github.com/barbagroup/geoclaw-landspill

Science Score: 95.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
Found 1 DOI reference(s) in JOSS metadata
✓
Academic publication links
Links to: joss.theoj.org
✓
Committers with academic emails
3 of 4 committers (75.0%) from academic institutions
○
Institutional organization owner
✓
JOSS paper metadata
Published in Journal of Open Source Software

Keywords

geoclaw land-spill overland-flow pipeline pipeline-ruptures shallow-water-equations

Scientific Fields

Earth and Environmental Sciences Physical Sciences - 37% confidence

Last synced: 4 months ago · JSON representation

Repository

An oil land-spill and overland flow simulator for pipeline rupture events

Basic Info

Host: GitHub
Owner: barbagroup
License: bsd-3-clause
Language: Fortran
Default Branch: master
Homepage:
Size: 14.1 MB

Statistics

Stars: 10
Watchers: 5
Forks: 8
Open Issues: 0
Releases: 5

Topics

geoclaw land-spill overland-flow pipeline pipeline-ruptures shallow-water-equations

Created about 7 years ago · Last pushed over 4 years ago

Metadata Files

Readme Contributing License Code of conduct Codemeta

geoclaw-landspill

Note: if looking for content of geoclaw-landspill-cases, please checkout tag v0.1. This repository has been converted to a fully working solver package.

geoclaw-landspill is a package for running oil overland flow simulations for applications in pipeline risk management. It includes a numerical solver and some pre-/post-processing utilities.

The numerical solver is a modified version of GeoClaw. GeoClaw solves full shallow-water equations. We added several new features and utilities to it and make it usable to simulate the overland flow from pipeline ruptures. These features include:

adding point sources to mimic the rupture points
adding evaporation models
adding Darcy-Weisbach bottom friction models with land roughness
adding temperature-dependent viscosity
recording detail locations and time of oil flowing into in-land waterbodies
downloading topography and hydrology data automatically (the US only)
generating CF-1.7 compliant NetCDF files

Documentation

Quick start

We only maintain compatibility with Linux. Though using pip or building from source may still work in Mac OS or Windows (e.g., through WSL), we are not able to help with the installation issues on these two systems.

Beyond this quick start, to see more details, please refer to the documentation section.

1. Installation

The fast way to install geoclaw-landspill is through Anaconda's conda command. The following command creates a conda environment (called landspill) and installs the package and dependencies:

$ conda create \ -n landspill -c barbagroup -c conda-forge \ python=3.8 geoclaw-landspill

Then use conda activate landspill or source <conda installation prefix>/bin/activate landspill to activate the environment. Type geoclaw-landspill --help in the terminal to see if geoclaw-landspill is correctly installed.

2. Running an example case

To run an example case under the folder cases, users have to clone this repository. We currently don't maintain another repository for cases. After cloning this repository, run $ geoclaw-landspill run <path to an example case folder> For example, to run utal-flat-maya: $ geoclaw-landspill run ./cases/utah-flat-maya Users can use environment variable OMP_NUM_THREADS to control how many CPU threads the simulation should use for OpenMP parallelization.

3. Creating a CF-compliant NetCDF raster file

After a simulation is done, users can convert flow depth in raw simulation data into a CF-compliant NetCDF raster file. For example, $ geoclaw-landspill createnc ./case/utah-flat-maya Replace ./cases/utah-flat-maya with the path to another desired case.

QGIS and ArcGIS should be able to read the resulting NetCDF raster file.

Third-party codes and licenses

amrclaw: https://github.com/clawpack/amrclaw (BSD 3-Clause License)
geoclaw: https://github.com/clawpack/geoclaw (BSD 3-Clause License)
pyclaw: https://github.com/clawpack/pyclaw (BSD 3-Clause License)
clawutil: https://github.com/clawpack/clawutil (BSD 3-Clause License)
riemann: https://github.com/clawpack/riemann (BSD 3-Clause License)

Contributing

See CONTRIBUTING.md.

Contact

Pi-Yueh Chuang: pychuang@gwu.edu

Owner

Name: Barba group
Login: barbagroup
Kind: organization
Location: Washington, DC

Website: http://lorenabarba.com
Repositories: 59
Profile: https://github.com/barbagroup

JOSS Publication

geoclaw-landspill: an oil land-spill and overland flow simulator for pipeline rupture events

Published

June 10, 2021

DOI

10.21105/joss.03114

Volume 6, Issue 62, Page 3114

Authors

Pi-Yueh Chuang

Department of Mechanical and Aerospace Engineering, the George Washington University, Washington, DC, USA

Tracy Thorleifson
G2 Integrated Solutions, Houston, TX, USA

Lorena A. Barba

Department of Mechanical and Aerospace Engineering, the George Washington University, Washington, DC, USA

Editor

Katy Barnhart

CodeMeta (codemeta.json)

{
  "@context": "https://raw.githubusercontent.com/codemeta/codemeta/master/codemeta.jsonld",
  "@type": "Code",
  "author": [
    {
      "@id": "https://orcid.org/0000-0001-6330-2709",
      "@type": "Person",
      "email": "pychuang@gwu.edu",
      "name": "Pi-Yueh Chuang",
      "affiliation": "Department of Mechanical and Aerospace Engineering, The George Washington University, Washington, DC, USA"
    },
    {
      "@id": "",
      "@type": "Person",
      "email": "Tracy.Thorleifson@g2-is.com",
      "name": "Tracy Thorleifson",
      "affiliation": "G2 Integrated Solutions, Houston, TX, USA"
    },
    {
      "@id": "http://orcid.org/0000-0001-5812-2711",
      "@type": "Person",
      "email": "labarba@gwu.edu",
      "name": "Lorena A. Barba",
      "affiliation": "Department of Mechanical and Aerospace Engineering, The George Washington University, Washington, DC, USA"
    }
  ],
  "identifier": "",
  "codeRepository": "https://github.com/barbagroup/geoclaw-landspill",
  "datePublished": "2021-01-11",
  "dateModified": "2021-01-11",
  "dateCreated": "2021-01-11",
  "description": "Oil land-spill and overland flow simulator for pipeline rupture events",
  "keywords": "geoclaw, overland-flow, pipeline, shallow-water-equations, pipeline-ruptures, land-spill",
  "license": "BSD 3-Clause",
  "title": "geoclaw-landspill",
  "version": "v1.0"
}

GitHub Events

Total

Watch event: 3

Last Year

Watch event: 3

Committers

Last synced: 5 months ago

All Time

Total Commits: 174
Total Committers: 4
Avg Commits per committer: 43.5
Development Distribution Score (DDS): 0.08

Past Year

Commits: 0
Committers: 0
Avg Commits per committer: 0.0
Development Distribution Score (DDS): 0.0

Top Committers

Name	Email	Commits
Pi-Yueh Chuang	p**g@g**u	160
Tracy Thorleifson	t**n@g**m	10
Lorena A. Barba	l**a@g**u	3
Katy Barnhart	k**t@u**v	1

Committer Domains (Top 20 + Academic)

gwu.edu: 2 usgs.gov: 1 g2-is.com: 1

Issues and Pull Requests

Last synced: 4 months ago

All Time

Total issues: 12
Total pull requests: 11
Average time to close issues: 8 days
Average time to close pull requests: 12 days
Total issue authors: 2
Total pull request authors: 3
Average comments per issue: 0.58
Average comments per pull request: 0.09
Merged pull requests: 11
Bot issues: 0
Bot pull requests: 0

Past Year

Issues: 0
Pull requests: 0
Average time to close issues: N/A
Average time to close pull requests: N/A
Issue authors: 0
Pull request authors: 0
Average comments per issue: 0
Average comments per pull request: 0
Merged pull requests: 0
Bot issues: 0
Bot pull requests: 0

View more stats

Top Authors

Issue Authors

piyueh (11)
jmansour (1)

Pull Request Authors

piyueh (9)
kbarnhart (1)
tthorleifson (1)

Top Labels

Issue Labels

enhancement (4) bug (1)

Pull Request Labels

Packages

Total packages: 1
Total downloads:
- pypi 11 last-month

Total dependent packages: 0
Total dependent repositories: 1
Total versions: 5
Total maintainers: 1

pypi.org: geoclaw-landspill

A hydrocarbon overland flow simulator for pipeline rupture events.

Homepage: https://github.com/barbagroup/geoclaw-landspill
Documentation: https://geoclaw-landspill.readthedocs.io/
License: BSD 3-Clause License
Latest release: 1.0
published over 4 years ago

Versions: 5
Dependent Packages: 0
Dependent Repositories: 1
Downloads: 11 Last month

Rankings

Dependent packages count: 10.1%

Forks count: 13.3%

Stargazers count: 20.4%

Average: 21.4%

Dependent repos count: 21.6%

Downloads: 41.4%

Maintainers (1)

pychuang

Last synced: 4 months ago

Dependencies

requirements-build.txt pypi

cmake >=3.18.4
ninja >=1.10
pytest >=6.2.1
scikit-build >=0.11.1
setuptools >=51.0
wheel >=0.36

requirements.txt pypi

matplotlib >=3.3.3
netCDF4 >=1.5.5.1
numpy >=1.19.4
psutil >=5.8.0
rasterio >=1.1.8
requests >=2.25.1
six >=1.15.0
typing_extensions >=3.7

geoclaw-landspill

Science Score: 95.0%

Keywords

Scientific Fields

Repository

Basic Info

Statistics

Topics

Metadata Files

README.md

geoclaw-landspill

Documentation

Quick start

1. Installation

2. Running an example case

3. Creating a CF-compliant NetCDF raster file

Third-party codes and licenses

Contributing

Contact

Owner

JOSS Publication

geoclaw-landspill: an oil land-spill and overland flow simulator for pipeline rupture events

Authors

Editor

Tags

CodeMeta (codemeta.json)

GitHub Events

Total

Last Year

Committers

All Time

Past Year

Top Committers

Committer Domains (Top 20 + Academic)

Issues and Pull Requests

All Time

Past Year

Top Authors

Issue Authors

Pull Request Authors

Top Labels

Issue Labels

Pull Request Labels

Packages

pypi.org: geoclaw-landspill

Rankings

Maintainers (1)

Dependencies