A modular interface for surrogate models and tools
Project description
|
.. image:: https://readthedocs.org/projects/surmise/badge/?version=latest :target: https://surmise.readthedocs.io/en/latest/?badge=latest :alt: Documentation Status
|
.. after_badges_rst_tag
=========================== 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
.. list-table:: Required dependencies:
:widths: 25 50 50
:header-rows: 1
* - Python_
- NumPy_
- SciPy_
* - 3.5
- 1.16, 1.17, 1.18
- 1.4
* - 3.6
- 1.16, 1.17, 1.18, 1.19
- 1.4
* - 3.7
- 1.16, 1.17, 1.18, 1.19
- 1.4
* - 3.8
- 1.18, 1.19
- 1.4
* - 3.9
- 1.20
- 1.6
Some examples require the optional dependency
* GPy_
Installation
From the command line, use the following command to install surmise::
pip install git+git://github.com/surmising/surmise.git
Alternatively, the source code can be downloaded to the local folder, and the package can be installed from the .tar file.
Testing
The test suite requires the pytest_ and pytest-cov_ packages to be installed
and can be run from the ``tests/`` directory of the source distribution by running::
./run-tests.sh
If you have the source distribution, you can run the tests in the top-level
directory containing the setup script with ::
python setup.py test
Further options are available for testing. To see a complete list of options, run::
./run-tests.sh -h
Coverage reports are produced under the relevant 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. These
files are hosted at Read the Docs <http://surmise.readthedocs.io>
_.
To compile the documentation, first ensure that Sphinx is installed. Then, to
generate documentation, run command make html
from terminal within this directory as follows ::
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:
.. code-block:: bibtex
@techreport{surmise2021, author = {Matthew Plumlee and Özge Sürer and Stefan M. Wild}, title = {Surmise Users Manual}, institution = {NAISE}, number = {Version 0.1.0}, year = {2021}, url = {https://surmise.readthedocs.io} }
Examples
We provide examples in the ``examples/`` directory to illustrate the basic usage
of surmise.
.. _NumPy: http://www.numpy.org
.. _pytest-cov: https://pypi.org/project/pytest-cov/
.. _pytest: https://pypi.org/project/pytest/
.. _Python: http://www.python.org
.. _SciPy: http://www.scipy.org
.. _GPy: https://gpy.readthedocs.io/en/deploy/
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.