uqpy

UQpy (Uncertainty Quantification with python) is a general purpose Python toolbox for modeling uncertainty in physical and mathematical systems.

https://github.com/surgroup/uqpy

Science Score: 67.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 1 DOI reference(s) in README
○
Academic publication links
✓
Committers with academic emails
11 of 25 committers (44.0%) from academic institutions
○
Institutional organization owner
○
JOSS paper metadata
○
Scientific vocabulary similarity
Low similarity (11.1%) to scientific vocabulary

Keywords

latin-hypercube latin-hypercube-sampling monte-carlo monte-carlo-simulation probabilistic probability stochastic stochastic-process uncertainty-propagation uncertainty-quantification uncertainty-sampling

Last synced: 6 months ago · JSON representation ·

Repository

UQpy (Uncertainty Quantification with python) is a general purpose Python toolbox for modeling uncertainty in physical and mathematical systems.

Basic Info

Host: GitHub
Owner: SURGroup
License: mit
Language: Python
Default Branch: main
Homepage:
Size: 173 MB

Statistics

Stars: 323
Watchers: 17
Forks: 88
Open Issues: 21
Releases: 26

Topics

Created about 8 years ago · Last pushed 6 months ago

Metadata Files

Readme Contributing License Code of conduct Citation

README.rst

|AzureDevops| |PyPIdownloads| |PyPI| |CondaPlatforms| |GithubRelease| |Docs| |bear-ified|

.. |Docs| image:: https://img.shields.io/readthedocs/uqpy?style=plastic  :alt: Read the Docs
.. |CondaPlatforms| image:: https://img.shields.io/conda/pn/SURG_JHU/uqpy?style=plastic   :alt: Conda
.. |GithubRelease| image:: https://img.shields.io/github/v/release/SURGroup/UQpy?style=plastic   :alt: GitHub release (latest by date)
.. |AzureDevops| image:: https://img.shields.io/azure-devops/build/UQpy/5ce1851f-e51f-4e18-9eca-91c3ad9f9900/1?style=plastic   :alt: Azure DevOps builds
.. |PyPIdownloads| image:: https://img.shields.io/pypi/dm/UQpy?style=plastic   :alt: PyPI - Downloads
.. |PyPI| image:: https://img.shields.io/pypi/v/UQpy?style=plastic   :alt: PyPI

.. |bear-ified| image:: https://raw.githubusercontent.com/beartype/beartype-assets/main/badge/bear-ified.svg
   :align: top
   :target: https://beartype.rtfd.io
   :alt: bear-ified


**********************************************
Uncertainty Quantification with python (UQpy)
**********************************************

|logo|

================================================================================================

.. list-table:: 
   :widths: 100, 200 
   :header-rows: 0

   * - **Product Owner:**
     - Michael D. Shields

   * - **Lead Developers:**
     - Dimitris Giovanis, Audrey Olivier, Dimitris Tsapetis

   * - **Development Team:**
     - Aakash Bangalore Satish, Mohit Singh Chauhan, Lohit Vandanapu, Ketson RM dos Santos, Katiana Kontolati, Dimitris Loukrezis, Promit Chakroborty, Lukáš Novák, Andrew Solanto, Connor Krill

   * - **Contributors:**
     - Michael Gardner, Prateek Bhustali, Julius Schultz, Ulrich Römer, Nicholas Betters
     


Contact
===========

To engage in conversations about uncertainty quantification, or ask question about UQpy usage and functionality refer to the UQpy's discussions tab:

`Discussions `_

Description
===========

UQpy (Uncertainty Quantification with python) is a general purpose Python toolbox for modeling uncertainty in physical and mathematical systems.

Documentation
================

Website:
           https://uqpyproject.readthedocs.io

Dependencies
===============

            * ::
            
                Python >= 3.9
                Git >= 2.13.1

License
===========
UQpy is distributed under the MIT license

Copyright (C) <2024> 

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.


Installation
===============

From PyPI

            * ::

                        pip install UQpy

Using Conda

            * ::

                        conda install -c conda-forge uqpy

Clone your fork of the UQpy repo from your GitHub account to your local disk (to get the latest version): 

            * ::

                        git clone https://github.com/SURGroup/UQpy.git
                        cd UQpy/
                        python setup.py {version} install  (user installation)
                        python setup.py {version} develop (developer installation)

You will need to replace {version} with the latest version.

Referencing UQpy
=================

If you are using this software in a work that will be published, please cite this paper:

Olivier, A., Giovanis, D.G., Aakash, B.S., Chauhan, M., Vandanapu, L., and Shields, M.D. (2020). "UQpy: A general purpose Python package and development environment for uncertainty quantification". Journal of Computational Science, DOI:  10.1016/j.jocs.2020.101204.


Help and Support
==================

For assistance with the UQpy software package, please raise an issue on the Github Issues page. Please use the appropriate labels to indicate which module you are specifically inquiring about.

.. |logo| image:: logo.jpg
    :height: 250px
    :target: https://github.com/SURGroup/UQpy

Owner

Name: SURG
Login: SURGroup
Kind: organization
Email: michael.shields@jhu.edu, dgiovan1@jhu.edu

Website: https://sites.google.com/site/jhusurg/
Repositories: 2
Profile: https://github.com/SURGroup

Citation (CITATION.cff)

cff-version: 1.2.0
message: "If you use this software, please cite it as below."
title: "UQpy"
version: 3.0.0
date-released: 2021-10-23
url: "https://github.com/SURGroup/UQpy"
preferred-citation:
  type: article
  authors:
  - family-names: "Olivier"
    given-names: "Audrey"
  - family-names: "Giovanis"
    given-names: "Dimitris"
  - family-names: "B.S."
    given-names: "Aakash"
  - family-names: "Chauhan"
    given-names: "Mohit"
  - family-names: "Vandanapu"
    given-names: "Lohit"
  - family-names: "Shields"
    given-names: "Michael"
  doi: "https://doi.org/10.1016/j.jocs.2020.101204"
  journal: "Journal of Computational Science"
  month: 9
  start: 101204 
  title: "UQpy: A general purpose Python package and development environment for uncertainty quantification"
  volume: 47
  year: 2020

GitHub Events

Total

Create event: 7
Release event: 3
Issues event: 6
Watch event: 43
Delete event: 5
Issue comment event: 9
Push event: 67
Pull request review event: 4
Pull request event: 22
Fork event: 4

Last Year

Create event: 7
Release event: 3
Issues event: 6
Watch event: 43
Delete event: 5
Issue comment event: 9
Push event: 67
Pull request review event: 4
Pull request event: 22
Fork event: 4

Committers

Last synced: about 2 years ago

All Time

Total Commits: 2,054
Total Committers: 25
Avg Commits per committer: 82.16
Development Distribution Score (DDS): 0.779

Past Year

Commits: 121
Committers: 8
Avg Commits per committer: 15.125
Development Distribution Score (DDS): 0.562

Top Committers

Name	Email	Commits
Dimitris Tsapetis	d**p@h**m	453
Michael Shields	m**s@j**u	249
dgiov16	m**d@h**m	241
dgiovanis	3****s	181
dgiovanis	d**1@j**u	169
AudOlivier	a**1@c**u	159
mohitcek	3****k	127
lohitv	l**u@g**m	97
Michael Shields	3****0	61
Prateek Bhustali	p**i@t**e	59
connor-krill	c**1@j**u	43
bsaakash	1****h	39
Lukas Novak	9****T	37
Mohit	m**1@j**u	35
Ketson R. M. dos Santos	4****o	33
Katiana Kontolati	k**1@j**u	17
Jiaxin	j**u@g**m	10
bsaakash	b**h@g**m	9
PromitChakroborty	p**1@j**u	8
NovakLBUT	n**l@f**z	7
Michael Gardner	s**3@g**m	6
Aakash	b**h@j**u	6
Rahul	m**8@g**m	4
audreyolivier	a**l@u**u	3
Michael Gardner	t**1@l**u	1

Committer Domains (Top 20 + Academic)

jhu.edu: 6 login2.frontera.tacc.utexas.edu: 1 usc.edu: 1 fce.vutbr.cz: 1 jh.edu: 1 tu-braunschweig.de: 1 columbia.edu: 1

Issues and Pull Requests

Last synced: 6 months ago

All Time

Total issues: 70
Total pull requests: 80
Average time to close issues: 6 months
Average time to close pull requests: about 2 months
Total issue authors: 19
Total pull request authors: 13
Average comments per issue: 0.39
Average comments per pull request: 0.88
Merged pull requests: 54
Bot issues: 0
Bot pull requests: 6

Past Year

Issues: 6
Pull requests: 23
Average time to close issues: N/A
Average time to close pull requests: 19 days
Issue authors: 6
Pull request authors: 3
Average comments per issue: 0.17
Average comments per pull request: 0.39
Merged pull requests: 14
Bot issues: 0
Bot pull requests: 2

View more stats

Top Authors

Issue Authors

mds2120 (46)
lohitv96 (4)
chiaraf10 (2)
mdtanker (2)
dimtsap (2)
connor-krill (1)
jjramsey (1)
LMedinaU (1)
xuhan-incore (1)
AudOlivier (1)
dgiovanis (1)
Kramer84 (1)
oarcelus (1)
frewenta (1)
jwarner308 (1)

Pull Request Authors

dimtsap (32)
connor-krill (25)
dependabot[bot] (8)
NovakLBUT (4)
lohitv96 (3)
mohitcek (2)
mdtanker (2)
dgiovanis (2)
ketsonroberto (2)
j824h (2)
marrov (1)
shellshocked2003 (1)
mds2120 (1)

Top Labels

Issue Labels

enhancement (48) bug (15) Sensitivity (1) Sampling (1) Surrogates (1)

Pull Request Labels

dependencies (8)

Packages

Total packages: 2
Total downloads:
- pypi 826 last-month

Total dependent packages: 0
(may contain duplicates)
Total dependent repositories: 3
(may contain duplicates)
Total versions: 52
Total maintainers: 2

pypi.org: uqpy

UQpy is a general purpose toolbox for Uncertainty Quantification

Homepage: https://github.com/SURGroup/UQpy
Documentation: https://uqpy.readthedocs.io/
License: MIT
Latest release: 4.2.1
published 6 months ago

Versions: 36
Dependent Packages: 0
Dependent Repositories: 0
Downloads: 826 Last month

Rankings

Stargazers count: 4.8%

Forks count: 5.3%

Dependent packages count: 7.3%

Downloads: 10.9%

Average: 19.4%

Dependent repos count: 68.5%

Maintainers (2)

Dgiov16 mds2120

Last synced: 6 months ago

conda-forge.org: uqpy

Homepage: https://github.com/SURGroup/UQpy
License: MIT
Latest release: 4.0.5
published over 3 years ago

Versions: 16
Dependent Packages: 0
Dependent Repositories: 3

Rankings

Dependent repos count: 17.9%

Forks count: 22.3%

Stargazers count: 27.8%

Average: 29.9%

Dependent packages count: 51.5%

Last synced: 6 months ago

Dependencies

setup.py pypi

beartype ==0.9.1
numpy *

Dockerfile docker

python 3.9 build

binder/requirements.txt pypi

UQpy *

docs/requirements.txt pypi

UQpy *
sphinx_autodoc_typehints *
sphinx_gallery *
sphinx_rtd_theme *
sphinxcontrib_bibtex *

docs/source/binder/requirements.txt pypi

UQpy *

requirements.txt pypi

beartype ==0.9.1
coverage ==5.3
fire ==0.4.0
matplotlib ==3.5.2
numpy ==1.22.3
pathlib *
pylint ==2.6.0
pytest ==6.1.2
pytest-azurepipelines ==0.8.0
pytest-cov ==2.10.1
scikit-learn ==1.0.2
scipy ==1.8.0
setuptools *
twine ==3.4.1
wheel ==0.36.2