SubsetTools
SubsetTools: A Python package to subset data to build and run ParFlow hydrologic models - Published in JOSS (2024)
Science Score: 100.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
✓CITATION.cff file
Found CITATION.cff file -
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
✓DOI references
Found 4 DOI reference(s) in README and JOSS metadata -
✓Academic publication links
Links to: joss.theoj.org -
✓Committers with academic emails
2 of 6 committers (33.3%) from academic institutions -
○Institutional organization owner
-
✓JOSS paper metadata
Published in Journal of Open Source Software
Repository
Subsetting tools and utilities for ParFlow hydrological modeling
Basic Info
- Host: GitHub
- Owner: hydroframe
- License: mit
- Language: Python
- Default Branch: main
- Homepage: https://hydroframesubsettools.readthedocs.io/en/latest/
- Size: 28.9 MB
Statistics
- Stars: 2
- Watchers: 7
- Forks: 4
- Open Issues: 5
- Releases: 1
Metadata Files
README.md
SubsetTools
Introduction
The SubsetTools package is developed and maintained by the HydroFrame project. It is designed to subset model inputs and outputs from the national ParFlow modeling framework. We provide tools to subset all required hydrogeologic and climate forcing datasets for a ParFlow simulation as well as obtaining pre-configured run scripts for your desired domain based on the most common use cases.
Example workflows are provided for working with both the first (PFCONUS1) and second (PFCONUS2) generation of the national model. Refer to the HydroFrame website for more information on these domains.
Subset tools has been configured to work with the HydroData data catalog which houses national ParFlow inputs and simulation results as well as a broad array of other hydrologic variables. Refer to the HydroData documentation for information on how to access additional datasets.
SubsetTools will provide you with ParFlow scripts that can run locally, but it should be noted that depending on the size of your domain you may want to deploy your runs on HPC resources. ParFlow is designed to run efficiently in parallel and all simulations can easily be distributed across multiple processors.
Checkout our Getting Started guide for installation instructions, information on creating a Hydrogen account, setting up a ParFlow run from templates and more! The HowTo section contains short examples, while the Example notebooks sections contains longer workflows that setup a ParFlow run at the end. The API reference contains the full list of available functions.
Citing SubsetTools
If you use our tools please cite this package in your work. You can cite the package by citing this paper 
In addition please make sure to cite all of the datasets that you subset. Examples for obtaining the DOIs for any dataset you use are provided in the examples.
Contributing
Interested in contributing? Check out the contributing guidelines on the SubsetTools ReadTheDocs. Please note that this project is released with a Code of Conduct. By contributing to this project, you agree to abide by its terms.
License
subsettools is part of the HydroFrame project. It is licensed under the terms of the MIT license.
Copyright 2024 The Trustees of Princeton University and The Arizona Board of Regents on behalf of the University of Arizona, College of Science Hydrology & Atmospheric Sciences
Owner
- Name: HydroFrame
- Login: hydroframe
- Kind: organization
- Website: https://www.hydroframe.org/
- Repositories: 9
- Profile: https://github.com/hydroframe
JOSS Publication
SubsetTools: A Python package to subset data to build and run ParFlow hydrologic models
Authors
Department of Hydrology and Atmospheric Sciences, University of Arizona, USA
Research Software Engineering, Princeton University, USA, Integrated GroundWater Modeling Center, Princeton University, USA
Research Software Engineering, Princeton University, USA, Integrated GroundWater Modeling Center, Princeton University, USA
Integrated GroundWater Modeling Center, Princeton University, USA, Department of Civil and Environmental Engineering, Princeton University, USA, High Meadows Environmental Institute, Princeton University, USA
Research Software Engineering, Princeton University, USA, Integrated GroundWater Modeling Center, Princeton University, USA
CyVerse, USA
Department of Hydrology and Atmospheric Sciences, University of Arizona, USA
Department of Hydrology and Atmospheric Sciences, University of Arizona, USA
Integrated GroundWater Modeling Center, Princeton University, USA
Integrated GroundWater Modeling Center, Princeton University, USA, Department of Civil and Environmental Engineering, Princeton University, USA
Department of Hydrology and Atmospheric Sciences, University of Arizona, USA
Editor
Taher Chegini
Tags
hydrology modeling simulationCitation (CITATION.cff)
cff-version: "1.2.0"
authors:
- family-names: Triplett
given-names: Amanda K.
orcid: "https://orcid.org/0009-0009-8085-3938"
- family-names: Artavanis
given-names: Georgios
orcid: "https://orcid.org/0009-0007-6015-7746"
- family-names: Hasling
given-names: William M.
- family-names: Maxwell
given-names: Reed M.
orcid: "https://orcid.org/0000-0002-1364-4441"
- family-names: Defnet
given-names: Amy
orcid: "https://orcid.org/0000-0003-2261-708X"
- family-names: Johnson
given-names: Amy M.
- family-names: Lytle
given-names: William
- family-names: Bennett
given-names: Andrew
- family-names: Leonarduzzi
given-names: Elena
- family-names: Gallagher
given-names: Lisa K.
- family-names: Condon
given-names: Laura E.
orcid: "https://orcid.org/0000-0003-3639-8076"
contact:
- family-names: Triplett
given-names: Amanda K.
orcid: "https://orcid.org/0009-0009-8085-3938"
- family-names: Artavanis
given-names: Georgios
orcid: "https://orcid.org/0009-0007-6015-7746"
- family-names: Maxwell
given-names: Reed M.
orcid: "https://orcid.org/0000-0002-1364-4441"
- family-names: Condon
given-names: Laura E.
orcid: "https://orcid.org/0000-0003-3639-8076"
doi: 10.5281/zenodo.12707059
message: If you use this software, please cite our article in the
Journal of Open Source Software.
preferred-citation:
authors:
- family-names: Triplett
given-names: Amanda K.
orcid: "https://orcid.org/0009-0009-8085-3938"
- family-names: Artavanis
given-names: Georgios
orcid: "https://orcid.org/0009-0007-6015-7746"
- family-names: Hasling
given-names: William M.
- family-names: Maxwell
given-names: Reed M.
orcid: "https://orcid.org/0000-0002-1364-4441"
- family-names: Defnet
given-names: Amy
orcid: "https://orcid.org/0000-0003-2261-708X"
- family-names: Johnson
given-names: Amy M.
- family-names: Lytle
given-names: William
- family-names: Bennett
given-names: Andrew
- family-names: Leonarduzzi
given-names: Elena
- family-names: Gallagher
given-names: Lisa K.
- family-names: Condon
given-names: Laura E.
orcid: "https://orcid.org/0000-0003-3639-8076"
date-published: 2024-07-17
doi: 10.21105/joss.06752
issn: 2475-9066
issue: 99
journal: Journal of Open Source Software
publisher:
name: Open Journals
start: 6752
title: "SubsetTools: A Python package to subset data to build and run
ParFlow hydrologic models"
type: article
url: "https://joss.theoj.org/papers/10.21105/joss.06752"
volume: 9
title: "SubsetTools: A Python package to subset data to build and run
ParFlow hydrologic models"
GitHub Events
Total
- Issues event: 2
- Delete event: 4
- Issue comment event: 9
- Push event: 45
- Pull request review event: 10
- Pull request review comment event: 7
- Pull request event: 26
- Fork event: 1
- Create event: 7
Last Year
- Issues event: 2
- Delete event: 4
- Issue comment event: 9
- Push event: 45
- Pull request review event: 10
- Pull request review comment event: 7
- Pull request event: 26
- Fork event: 1
- Create event: 7
Committers
Last synced: 7 months ago
Top Committers
| Name | Commits | |
|---|---|---|
| George Artavanis | g****6@v****u | 224 |
| gartavanis | 3****s | 87 |
| aktriplett | 5****t | 24 |
| aktriplett | a****t@e****u | 23 |
| arbennett | b****r@g****m | 2 |
| Emily Wilborn | 1****n | 2 |
Committer Domains (Top 20 + Academic)
Issues and Pull Requests
Last synced: 6 months ago
All Time
- Total issues: 9
- Total pull requests: 101
- Average time to close issues: 3 months
- Average time to close pull requests: 3 days
- Total issue authors: 6
- Total pull request authors: 7
- Average comments per issue: 1.56
- Average comments per pull request: 0.13
- Merged pull requests: 92
- Bot issues: 0
- Bot pull requests: 0
Past Year
- Issues: 2
- Pull requests: 21
- Average time to close issues: N/A
- Average time to close pull requests: 10 days
- Issue authors: 2
- Pull request authors: 4
- Average comments per issue: 0.0
- Average comments per pull request: 0.48
- Merged pull requests: 18
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
- gartavanis (3)
- JannisHoch (2)
- aktriplett (1)
- westb2 (1)
- reedmaxwell (1)
- hstone31 (1)
Pull Request Authors
- gartavanis (115)
- wh3248 (7)
- egwilborn (7)
- amy-defnet (3)
- rlsandovalp (2)
- arbennett (1)
Top Labels
Issue Labels
Pull Request Labels
Dependencies
- myst-nb *
- sphinx-autoapi *
- sphinx-rtd-theme *