Metadata-Version: 2.1
Name: pyapprox
Version: 1.0.3
Summary: High-dimensional function approximation and estimation
Home-page: https://github.com/sandialabs/pyapprox
Author: John D. Jakeman
Author-email: "John D. Jakeman" <29109026+jdjakem@users.noreply.github.com>
License: Copyright 2019 National Technology & Engineering Solutions of Sandia, LLC (NTESS). Under the terms of Contract DE-NA0003525 with NTESS, the U.S. Government retains certain rights in this software.
        
        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.
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy >=1.16.4
Requires-Dist: matplotlib
Requires-Dist: scipy >=1.0.0
Requires-Dist: Cython
Requires-Dist: sympy
Requires-Dist: torch
Requires-Dist: scikit-learn
Requires-Dist: coverage >=6.4
Requires-Dist: pytest-cov
Requires-Dist: pytest >=4.6
Requires-Dist: networkx
Requires-Dist: numba
Requires-Dist: scikit-fem
Requires-Dist: umbridge
Provides-Extra: docs
Requires-Dist: numpydoc ; extra == 'docs'
Requires-Dist: sphinx ; extra == 'docs'
Requires-Dist: sphinx-automodapi ; extra == 'docs'
Requires-Dist: sphinx-rtd-theme ; extra == 'docs'
Requires-Dist: sphinx-gallery ; extra == 'docs'
Requires-Dist: jupyter ; extra == 'docs'

[![Actions Status](https://github.com/sandialabs/pyapprox/workflows/Build%20and%20Test%20Using%20Pip/badge.svg)](https://github.com/sandialabs/pyapprox/actions)
[![Actions Status](https://github.com/sandialabs/pyapprox/workflows/Build%20and%20Test%20Using%20Conda/badge.svg)](https://github.com/sandialabs/pyapprox/actions)

# PyApprox

Documentation
-------------
Online documentation can be found at [PyApprox](https://sandialabs.github.io/pyapprox/index.html)

Description
-----------
PyApprox provides flexible and efficient tools for high-dimensional approximation and uncertainty quantification. PyApprox implements methods addressing various issues surrounding high-dimensional parameter spaces and limited evaluations of expensive simulation models with the goal of facilitating simulation-aided knowledge discovery, prediction and design. Tools are provided for: (1) building surrogates using polynomial chaos expansions using least squares, compressive sensing and interpolation; (2) sparse grid interpolation and quadrature; (3) low-rank tensor-decompositions; (4) multi-fidelity approximation and sampling; (5) large-scale Bayesian inference; (6) numerical solvers for canonical ordinary and partial differential equations useful for demonstration purposes; (7) compressive sensing solvers; and (8) visualization. The code is intended to as a python toolbox but provides c++ code with Python interfaces to computationally expensive algorithms to increase performance.

Practical Application
---------------------
The software provides foundational numerical algorithms for approximation of multivariate functions and quantifying uncertainty in numerical models. The software is primarily used to build surrogates of generic functions. Often such functions are quantities of interest of numerical simulation models of, for example, sea-level change due to ice-sheet evolution, or ground-water flow. Once surrogates are generated they are used to undertake sensitivity analysis to identity important model parameters and to compute statistics of the variable model output caused by sources of uncertainty.

Method of Solution
------------------
The tools provided are based on mathematical algorithms for: (1) building surrogates using polynomial chaos expansions using least squares, compressive sensing and interpolation; (2) sparse grid interpolation and quadrature; (3) low-rank tensor-decompositions; (4) multi-fidelity approximation and sampling; (5) large-scale Bayesian inference; (6) numerical solvers for canonical ordinary and partial differential equations useful for demonstration purposes; and (7) compressive sensing solvers. The modularity of the code structure and function API are intended to facilitate flexible use and extension of the available tools. Numerous functions are provided to facilitate testing and benchmarking of algorithms.

Acknowledgements
----------------
This research was developed with funding from the Defense Advanced Research Projects Agency (DARPA). The views, opinions and/or findings expressed are those of the author and should not be interpreted as representing the official views or policies of the Department of Defense or the U.S. Government.
