Skip to main content

Quantify uncertainty and sensitivities in your computer models with an industry-grade Monte Carlo library.

Project description

Release Builds Tests Docs codecov PyPI - Python Version

Quantify uncertainty and sensitivities in your computer models with an industry-grade Monte Carlo library.

Overview

At the heart of all serious forecasting, whether that be of elections, the spread of pandemics, weather, or the path of a rocket on its way to Mars, is a statistical tool known as the Monte Carlo method. The Monte Carlo method, named for the rolling of the dice at the famous Monte Carlo casino located in Monaco, allows you to quantify uncertainty by introducing randomness to otherwise deterministic processes, and seeing what the range of results is.

monaco is a python library for analyzing uncertainties and sensitivities in your computational models by setting up, running, and analyzing a Monte Carlo simulation wrapped around that model. Users can define random input variables drawn using chosen sampling methods from any of SciPy's continuous or discrete distributions (including custom distributions), preprocess and structure that data as needed to feed to their main simulation, run that simulation in parallel anywhere from 1 to millions of times, and postprocess the simulation outputs to obtain meaningful, statistically significant conclusions. Plotting and statistical functions specific to use cases that might be encountered are provided, and repeatability of results is ensured through careful management of random seeds.

Quick Start

First, install monaco:

pip install monaco

Then, copy the two files from the template directory, which contains a simple, well commented Monte Carlo simulation of flipping coins. That link also contains some exercises for you to do, to help you familiarize yourself with how monaco is structured.

After working through the template exercises, check out the other examples for inspiration and more in-depth usage of monaco's features.

Documentation / API Reference / SciPy 2022 Talk

Documentation is being built up - read the docs here: https://monaco.readthedocs.io

Currently there is a complete API reference, more detailed installation, test, and publishing instructions, an overview of the basic architecture and basic workflow, and some details on statistical distributions and sampling methods.

Monaco was presented at the SciPy 2022 Conference, and the conference resources should give another good overview of the library. Check out the paper, the video of the talk, and the talk's slides and notebooks.

License / Citation

Copyright 2020 Scott Shambaugh, distributed under the MIT license.

If you use monaco to do research that gets published, please cite the conference paper using the below or monaco.bib:

W. Scott Shambaugh (2022). Monaco: A Monte Carlo Library for Performing Uncertainty and Sensitivity Analyses. In Proceedings of the 21st Python in Science Conference (pp. 202 - 208).

Further Reading

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

monaco-0.11.6.tar.gz (52.7 kB view details)

Uploaded Source

Built Distribution

monaco-0.11.6-py3-none-any.whl (58.3 kB view details)

Uploaded Python 3

File details

Details for the file monaco-0.11.6.tar.gz.

File metadata

  • Download URL: monaco-0.11.6.tar.gz
  • Upload date:
  • Size: 52.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/4.0.2 CPython/3.11.8

File hashes

Hashes for monaco-0.11.6.tar.gz
Algorithm Hash digest
SHA256 0c310bfedc5933a3f9f7d899365823e46d689e271c6a8b03e6c4643bd2905e50
MD5 d7dd71de20ceb554888162fefc53cd0b
BLAKE2b-256 378ac1d3d2418702d1c33d287ea9ea7f0a15ac63bc9f7484d2aa16429ef400b9

See more details on using hashes here.

File details

Details for the file monaco-0.11.6-py3-none-any.whl.

File metadata

  • Download URL: monaco-0.11.6-py3-none-any.whl
  • Upload date:
  • Size: 58.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/4.0.2 CPython/3.11.8

File hashes

Hashes for monaco-0.11.6-py3-none-any.whl
Algorithm Hash digest
SHA256 03152bc0d94225a44e9a2f567ada017f3d803b7eac5947d87a064f99d32d5a82
MD5 3832d3752d90c6b86f28328926e84cad
BLAKE2b-256 c3743a57614f2aab18c72b25f109860eb72a022bbe47f47bfe6b3d053cbadb31

See more details on using hashes here.

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