Skip to main content

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

Project description

Release Downloads 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.13.2.tar.gz (52.4 kB view details)

Uploaded Source

Built Distribution

monaco-0.13.2-py3-none-any.whl (57.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: monaco-0.13.2.tar.gz
  • Upload date:
  • Size: 52.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.0 CPython/3.12.4

File hashes

Hashes for monaco-0.13.2.tar.gz
Algorithm Hash digest
SHA256 4d18b5dd97870c4ee461ed9703cb0df5962443b189465d01d4050abd57cdc963
MD5 fae5d826ebcebb4b60f99e86485839a0
BLAKE2b-256 9a8765c3ee7029947a2c659b1910245bf4fdf4450f504eddc74eb1344268d539

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: monaco-0.13.2-py3-none-any.whl
  • Upload date:
  • Size: 57.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.0 CPython/3.12.4

File hashes

Hashes for monaco-0.13.2-py3-none-any.whl
Algorithm Hash digest
SHA256 fcc8a545bd5c0e5f6c4af3f3699574692c18780b4bbe3f3913e839605b726a6b
MD5 f1631b80f354db08f0b475306805677f
BLAKE2b-256 429ab77bd1df33dc9a0d1890fb1e028f39cbb82926aaf84388f01cbc95083d16

See more details on using hashes here.

Provenance

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