PyThia Uncertainty Quantification Toolbox
The PyThia UQ toolbox uses polynomial chaos surrogates to efficiently generate a surrogate of any (parametric) forward problem. The surrogate is fast to evaluate, allows analytical differentiation and has a built-in global sensitivity analysis via Sobol indices. Assembling the surrogate is done non-intrusive by least-squares regression, hence only training pairs of parameter realizations and evaluations of the forward problem are required to construct the surrogate. No need to compute any nasty interfaces for lagacy code.
Why the Name?
Pythia was the title of the high priestess of the temple of Apollo in Delphi. Hence you could say she used her prophetic abilities to quantify which was uncertain. Moreover, the package is written in python, so...
Installation
The latest stable version of PyThia can be installed using pip
pip install pythia-uq
To install PyThia from source, i.e., if you want to work with the latest (and possibly unstable) changes, simply clone the repository and run the setup script to install PyThia to any environment
cd path/to/pythia-repo/
pip install .
PyThia can then be imported from any location with import pythia.
Documentation
The documentation of the stable package version can be found here: pythia-uq.rtfd.io. For other versions of the documentation, see https://readthedocs.org/projects/pythia-uq/.
How to cite PyThia
There is no official related article to cite PyThia yet.
If you make use of PyThia in a publication, please use the meta data from the CITATION.cff file or cite it with a BibTeX entry similar to this:
@misc{pythia,
author = {Hegemann, Nando and Heidenreich, Sebastian},
title = {PyThia UQ Toolbox},
doi = {10.5281/ZENODO.8329011},
url = {https://zenodo.org/record/8329011},
language = {en},
publisher = {Zenodo},
year = {2023},
month = {9},
copyright = {GNU Lesser General Public License v3.0 or later}
}
Want to contribute?
Check out the contribution guidelines on how to create issues or file bug reports and feature requests. Or ever better start developping the PyThia project yourself after reading the development guidelines.
License
This work is dual-licensed under GNU Lesser General Public License v3.0 or later and Hippocratic License 3.0 or later. You can choose between one of them if you use this work.
SPDX-License-Identifier: LGPL-3.0-or-later OR Hippocratic-3.0-ECO-MEDIA-MIL
Funding
The development of PyThia UQ Toolbox vers. 1 and 2 has been funded by the German Central Innovation Program (ZIM) No. ZF4014017RR7. The development of PyThia UQ Toolbox vers. 3 and 4 has been funded by the EMPIR project 20IND04-ATMOC.
Logo
Access and usage information about the PyThia logo can be found under the following URL: https://gitlab.com/pythia-uq/pythia-logo.
References
Here we list the papers that describe concepts implemented in PyThia for the interested user. In principle PyThia uses a (sparse) polynomial chaos expansion to construct a surrogate of any function via least-squares regression. We first applied the PyThia software package to analyse the sensitivities of a scatterometry experiment 1 using global sensitivity analysis via Sobol indices 2. We also solved the inverse problem for the same experiment 3 via Bayesian inversion. To use a minimal but still sufficient amount of random samples for the regression, we integrated weighted least-squares sampling 4 into PyThia.
Metadata
Release files for pythia-uq 4.0.3
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| pythia-uq-4.0.3.tar.gz | 45.0 kB | Without provenance | Details for pythia-uq-4.0.3.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| pythia_uq-4.0.3-py3-none-any.whl | Python 3 | none | any | Details for pythia_uq-4.0.3-py3-none-any.whl |
Total release size: 82.0 kB
Release files / pythia-uq-4.0.3.tar.gz
| Download URL | pythia-uq-4.0.3.tar.gz |
|---|---|
| Size | 45.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
fa8fcd0b9dc5888ba90b6e0f0e408390f826e35c650604417d93d2b5594cba2a
|
|
BLAKE2b-256 checksum How to use checksums |
6199895b10fb710c3770a972f487fc4b9abccd39a6c69d8cf81abaf21fe43f24
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.10.12
|
Release files / pythia_uq-4.0.3-py3-none-any.whl
| Download URL | pythia_uq-4.0.3-py3-none-any.whl |
|---|---|
| Size | 37.0 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
b04569b871201e345e5f084e338fc89014a326f335bf06ca3e154863dd871cdb
|
|
BLAKE2b-256 checksum How to use checksums |
fcc8a49a969efe26cf2a97eb84de7cfa2fdbabfbb3b818ee65eaad36ff756435
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.10.12
|
Security for pythia-uq 4.0.3
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.