Skip to main content

A modular interface for surrogate models and tools

Project description


https://badge.fury.io/py/surmise.svg Documentation Status https://github.com/bandframework/surmise/actions/workflows/python-package.yml/badge.svg

Introduction to surmise

surmise is a Python package that is designed to provide a surrogate model interface for calibration, uncertainty quantification, and sensitivity analysis.

Dependencies

surmise is build for Python 3.8 or above, with the following dependencies:

  • numpy>=1.18.3

  • scipy>=1.7

  • scikit-learn>=1.2.0

Installation

From the command line, use the following command to install surmise:

pip install surmise

The list of available .whl files can be found under PyPI-wheel. If a wheel file for your preferred platform is not listed, surmise has to be built from source, which requires extra dependencies:

git clone https://github.com/bandframework/surmise/
cd surmise
pip install -r requirements.txt

Testing

The test suite requires the pytest and pytest-cov packages to be installed. The packages can be installed via:

pip install pytest pytest-cov

The test suite can then be run from within the tests/ directory of the source distribution by running:

cd tests
./run-tests.sh

Further options are available for testing. To see a complete list of options, run:

./run-tests.sh -h

Coverage reports are produced under tests/cov_html directory only if all tests are used.

Documentation

The documentation is stored in docs/ and is compiled with the Sphinx Python documentation generator. It is written in the reStructuredText format. The documentation is hosted at Read the Docs.

To compile the documentation, first ensure that Sphinx and its dependencies are installed. To install Sphinx and/or ensure compatibility of dependencies, run make from a terminal within the docs/ directory:

cd docs
make

To generate documentation, run command make html from a terminal within the docs/ directory:

(cd docs)
make html

The HTML files are then stored in docs/_build/html.

Citation:

  • Please use the following to cite surmise in a publication:

@techreport{surmise2023,
  author      = {Matthew Plumlee and \"Ozge S\"urer and Stefan M. Wild and Moses Y-H. Chan},
  title       = {{surmise 0.2.0} Users Manual},
  institution = {NAISE},
  number      = {Version 0.2.0},
  year        = {2023},
  url         = {https://surmise.readthedocs.io}
}

Examples

We provide examples in the examples/ directory to illustrate the basic usage of surmise.

In addition, for a gentle introduction of emulation and calibration using Gaussian processes, visit surmise Jupyter notebook.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

surmise-0.2.1.tar.gz (12.2 MB view hashes)

Uploaded Source

Built Distributions

surmise-0.2.1-cp312-cp312-win_amd64.whl (152.6 kB view hashes)

Uploaded CPython 3.12 Windows x86-64

surmise-0.2.1-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (618.9 kB view hashes)

Uploaded CPython 3.12 manylinux: glibc 2.17+ x86-64

surmise-0.2.1-cp312-cp312-macosx_10_9_x86_64.whl (165.2 kB view hashes)

Uploaded CPython 3.12 macOS 10.9+ x86-64

surmise-0.2.1-cp311-cp311-win_amd64.whl (152.6 kB view hashes)

Uploaded CPython 3.11 Windows x86-64

surmise-0.2.1-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (618.8 kB view hashes)

Uploaded CPython 3.11 manylinux: glibc 2.17+ x86-64

surmise-0.2.1-cp311-cp311-macosx_10_9_x86_64.whl (164.6 kB view hashes)

Uploaded CPython 3.11 macOS 10.9+ x86-64

surmise-0.2.1-cp310-cp310-win_amd64.whl (152.4 kB view hashes)

Uploaded CPython 3.10 Windows x86-64

surmise-0.2.1-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (572.0 kB view hashes)

Uploaded CPython 3.10 manylinux: glibc 2.17+ x86-64

surmise-0.2.1-cp310-cp310-macosx_10_9_x86_64.whl (164.6 kB view hashes)

Uploaded CPython 3.10 macOS 10.9+ x86-64

surmise-0.2.1-cp39-cp39-win_amd64.whl (153.0 kB view hashes)

Uploaded CPython 3.9 Windows x86-64

surmise-0.2.1-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (574.7 kB view hashes)

Uploaded CPython 3.9 manylinux: glibc 2.17+ x86-64

surmise-0.2.1-cp39-cp39-macosx_10_9_x86_64.whl (165.2 kB view hashes)

Uploaded CPython 3.9 macOS 10.9+ x86-64

surmise-0.2.1-cp38-cp38-win_amd64.whl (153.0 kB view hashes)

Uploaded CPython 3.8 Windows x86-64

surmise-0.2.1-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (589.9 kB view hashes)

Uploaded CPython 3.8 manylinux: glibc 2.17+ x86-64

surmise-0.2.1-cp38-cp38-macosx_10_9_x86_64.whl (164.9 kB view hashes)

Uploaded CPython 3.8 macOS 10.9+ x86-64

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page