pestpp

tools for scalable and non-intrusive parameter estimation, uncertainty analysis and sensitivity analysis

https://github.com/usgs/pestpp

Science Score: 57.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 25 DOI reference(s) in README
  • Academic publication links
  • Committers with academic emails
    7 of 21 committers (33.3%) from academic institutions
  • Institutional organization owner
    Organization usgs has institutional domain (www.usgs.gov)
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (14.0%) to scientific vocabulary

Keywords

ensemble-methods ensembles global-sensitivity-analysis non-intrusive optimization optimization-tools parallel-computing parameter-estimation sensitivity-analysis uncertainty-quantification

Keywords from Contributors

uncertainty-analysis earth-science groundwater modflow
Last synced: 6 months ago · JSON representation

Repository

tools for scalable and non-intrusive parameter estimation, uncertainty analysis and sensitivity analysis

Basic Info
  • Host: GitHub
  • Owner: usgs
  • Language: C++
  • Default Branch: master
  • Homepage:
  • Size: 1.12 GB
Statistics
  • Stars: 156
  • Watchers: 25
  • Forks: 86
  • Open Issues: 35
  • Releases: 65
Topics
ensemble-methods ensembles global-sensitivity-analysis non-intrusive optimization optimization-tools parallel-computing parameter-estimation sensitivity-analysis uncertainty-quantification
Created almost 7 years ago · Last pushed 6 months ago
Metadata Files
Readme

README.md

pestpplogo image

PEST++

a Software Suite for Parameter Estimation, Uncertainty Analysis, Management Optimization and Sensitivity Analysis

PEST++ is a software suite aimed at supporting complex numerical models in the decision-support context. Much focus has been devoted to supporting environmental models (groundwater, surface water, etc) but these tools are readily applicable to any computer model.


Master branch: master branch

Develop branch: develop


Documentation

The latest official report documenting PEST++ is available from the USGS:

https://pubs.er.usgs.gov/publication/tm7C26

Suggested Citation:

White, J.T., Hunt, R.J., Fienen, M.N., and Doherty, J.E., 2020, Approaches to Highly Parameterized Inversion: PEST++ Version 5, a Software Suite for Parameter Estimation, Uncertainty Analysis, Management Optimization and Sensitivity Analysis: U.S. Geological Survey Techniques and Methods 7C26, 52 p., https://doi.org/10.3133/tm7C26.


User's Manual

The latest PEST++ users manual is available here or as a word document.


Links to latest binaries

As of version 4.3.11, PEST++ pre-compiled binaries for windows and linux are available as a github release:

https://github.com/usgs/pestpp/releases


Compiling

The develop branch includes a Visual Studio solution, as well as CMake files for building on all operating systems using g++, MSVC, and/or intel C++.

See details here to compile using CMake.


Overview

The PEST++ software suite includes several stand-alone tools for model-independent (non-intrusive) computer model parameter estimation and uncertainty analysis. Codes include:

  • pestpp-glm: deterministic GLM parameter estimation using "on-the-fly" subspace reparameterization, effectively reproducing the SVD-Assist methodology of PEST without any user intervention and FOSM-based parameter and (optional) forecast uncertainty estimation with support for generating Bayes-linear posterior parameter realizations.

  • pestpp-sen: Global sensitivity analysis using either Morris or Sobol

  • pestpp-swp: a generic parallel run utility driven by a CSV file of parameter values

  • pestpp-opt: chance-constrained linear programming

  • pestpp-ies: iterative ensemble smoother implementation of GLM (based on the work Chen and Oliver 2013) with support for generic localization (local analysis and/or covariance localization)

  • pestpp-mou: multi-objective optimization under uncertainty using evolutionary algorithms (single objective also!)

  • pestpp-da: model-independent ensemble-based sequential and batch iterative data assimilation with options to use standard Kalman update, multiple data assimilation (MDA), or the GLM algorithm of Chen and Oliver (2013).

All members of the software suite can be compiled for PC, MAC, or Linux and have several run managers to support parallelization. Windows users with older OS versions should use the iwin binaries (starting "i", compiled with intel C++) to avoid the dreaded MSVC missing runtime DLL issue.


Funding

Funding for PEST++ has been provided by the U.S. Geologial Survey. The New Zealand Strategic Science Investment Fund as part of GNS Science’s (https://www.gns.cri.nz/) Groundwater Research Programme has also funded contributions 2018-present. Intera, Inc. also provides ongoing support for PEST++.


PEST++ References:

White, J.T., Hunt, R.J., Fienen, M.N., and Doherty, J.E., 2020, Approaches to Highly Parameterized Inversion: PEST++ Version 5, a Software Suite for Parameter Estimation, Uncertainty Analysis, Management Optimization and Sensitivity Analysis: U.S. Geological Survey Techniques and Methods 7C26, 52 p., https://doi.org/10.3133/tm7C26.

White, J. T., 2018, A model-independent iterative ensemble smoother for efficient history-matching and uncertainty quantification in very high dimensions. Environmental Modelling & Software. 109. 10.1016/j.envsoft.2018.06.009. http://dx.doi.org/10.1016/j.envsoft.2018.06.009.

White, J. T., Fienen, M. N., Barlow, P. M., and Welter, D.E., 2017, A tool for efficient, model-independent management optimization under uncertainty. Environmental Modeling and Software. http://dx.doi.org/10.1016/j.envsoft.2017.11.019.

Welter, D.E., White, J.T., Hunt, R.J., and Doherty, J.E., 2015, Approaches in highly parameterized inversion— PEST++ Version 3, a Parameter ESTimation and uncertainty analysis software suite optimized for large environmental models: U.S. Geological Survey Techniques and Methods, book 7, chap. C12, 54 p., http://dx.doi.org/10.3133/tm7C12.

Welter, D.E., Doherty, J.E., Hunt, R.J., Muffels, C.T., Tonkin, M.J., and Schreüder, W.A., 2012, Approaches in highly parameterized inversion—PEST++, a Parameter ESTimation code optimized for large environmental models: U.S. Geological Survey Techniques and Methods, book 7, section C5, 47 p., available only at http://pubs.usgs.gov/tm/tm7c5.


Related Links:


Testing

The benchmarks folder contains a simple worked example and basic testing routines that are used for basic CI testing. Many full-worked test problems of varying sizes are now located in separate repos:


Dependencies

Much work has been done to avoid additional external dependencies in PEST++. As currently designed, the project is fully self-contained.


optional ++ arguments

please see the PEST++ users manual in the documentation directory for a current and complete description of all ++ options


USGS disclaimer

This software has been approved for release by the U.S. Geological Survey (USGS). Although the software has been subjected to rigorous review, the USGS reserves the right to update the software as needed pursuant to further analysis and review. No warranty, expressed or implied, is made by the USGS or the U.S. Government as to the functionality of the software and related material nor shall the fact of release constitute any such warranty. Furthermore, the software is released on condition that neither the USGS nor the U.S. Government shall be held liable for any damages resulting from its authorized or unauthorized use

Owner

  • Name: U.S. Geological Survey
  • Login: usgs
  • Kind: organization
  • Email: gs_help_git@usgs.gov
  • Location: Reston, VA, USA

By integrating our diverse scientific expertise, we understand complex natural science phenomena and provide scientific products that lead to solutions.

GitHub Events

Total
  • Create event: 10
  • Release event: 9
  • Issues event: 9
  • Watch event: 22
  • Delete event: 2
  • Member event: 4
  • Issue comment event: 38
  • Push event: 31
  • Pull request event: 42
  • Fork event: 15
Last Year
  • Create event: 10
  • Release event: 9
  • Issues event: 9
  • Watch event: 22
  • Delete event: 2
  • Member event: 4
  • Issue comment event: 38
  • Push event: 31
  • Pull request event: 42
  • Fork event: 15

Committers

Last synced: 6 months ago

All Time
  • Total Commits: 2,049
  • Total Committers: 21
  • Avg Commits per committer: 97.571
  • Development Distribution Score (DDS): 0.555
Past Year
  • Commits: 107
  • Committers: 3
  • Avg Commits per committer: 35.667
  • Development Distribution Score (DDS): 0.065
Top Committers
Name Email Commits
jtwhite79 j****0@g****m 912
jdub J****e@l****l 526
jwhite-usgs j****s@g****m 467
Ayman Alzraiee a****e@g****m 47
Matthew Knowling m****g@a****u 30
Zachary Stanko z****o@u****v 21
Mike Taves m****s@g****m 20
jdhughes-dev j****1@g****m 6
Mike Fienen m****n@u****v 3
Damian Merrick d****k@h****m 3
gmartinez@intera.com g****t 3
jwhite j****e@i****v 2
Chris Nicol c****l@g****m 1
Randy Hunt r****t@u****v 1
Tim Cera t****m@c****t 1
Wes Kitlasten w****n@u****v 1
adam siade a****e@u****u 1
jwhite j****e@j****l 1
briochh b****s@.****z 1
Parallels p****s@c****d 1
jdhughes-dev j****9@g****m 1

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 105
  • Total pull requests: 157
  • Average time to close issues: 4 months
  • Average time to close pull requests: 6 days
  • Total issue authors: 52
  • Total pull request authors: 17
  • Average comments per issue: 4.18
  • Average comments per pull request: 0.31
  • Merged pull requests: 135
  • Bot issues: 0
  • Bot pull requests: 3
Past Year
  • Issues: 12
  • Pull requests: 45
  • Average time to close issues: about 1 month
  • Average time to close pull requests: 9 days
  • Issue authors: 8
  • Pull request authors: 10
  • Average comments per issue: 1.08
  • Average comments per pull request: 0.33
  • Merged pull requests: 30
  • Bot issues: 0
  • Bot pull requests: 3
Top Authors
Issue Authors
  • wkitlasten (20)
  • BJEANNOT0 (12)
  • laat0003 (7)
  • jbensabat (7)
  • mwtoews (3)
  • RyanConway91 (2)
  • DStrom1987 (2)
  • oscarfasanchez (2)
  • BJeannot1 (2)
  • ckikuchi (2)
  • ghost (2)
  • Kumbaka (2)
  • cnicol-gwlogic (2)
  • kyledavis-usgs (2)
  • flydream0428 (1)
Pull Request Authors
  • jtwhite79 (80)
  • jwhite-usgs (31)
  • mwtoews (14)
  • mnfienen (5)
  • rhugman (5)
  • mmorphew (4)
  • jdhughes-dev (4)
  • dependabot[bot] (3)
  • rqmacasieb (2)
  • briochh (2)
  • MJKnowling (1)
  • siadicus (1)
  • damianmerrick (1)
  • cnicol-gwlogic (1)
  • joshbode (1)
Top Labels
Issue Labels
Pull Request Labels
dependencies (3) github_actions (3)

Dependencies

.github/workflows/ci.yml actions
  • actions/checkout v2.3.4 composite
  • ilammy/msvc-dev-cmd v1 composite
  • mamba-org/setup-micromamba v1 composite
  • seanmiddleditch/gha-setup-ninja master composite
requirements.travis.txt pypi
  • matplotlib *
  • numpy *
  • pandas *
  • pyproj *
  • pyshp *
etc/environment.yml conda
  • coveralls
  • flopy
  • git
  • imp
  • jinja2
  • matplotlib >=1.4.0
  • mfpymake
  • nbmake
  • nose
  • nose-timer
  • numpy >=1.15.0
  • pandas
  • pip
  • pyshp
  • pytest-xdist
  • python <=3.11
  • scipy
  • shapely