Skip to main content

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

Project description

Release Builds Tests Docs PyPI - Python Version

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

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

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.

License / Citation

Copyright 2020-2022 Scott Shambaugh, distributed under the GPLv3.0 (or later) license.
If you use monaco to do research that gets published, please cite the monaco github page.

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.4.0.tar.gz (54.9 kB view details)

Uploaded Source

Built Distribution

monaco-0.4.0-py3-none-any.whl (59.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: monaco-0.4.0.tar.gz
  • Upload date:
  • Size: 54.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.13 CPython/3.10.4 Linux/5.10.16.3-microsoft-standard-WSL2

File hashes

Hashes for monaco-0.4.0.tar.gz
Algorithm Hash digest
SHA256 a27982f840ab88032f8b75c00b202c28d91222b8956e3ee362660d818b1d7d85
MD5 71880e0ba65a29c8f61d749030718096
BLAKE2b-256 e2e64b552170e5338f0885ed45f5a58de8f04553f8ba32a211e864f35840a40f

See more details on using hashes here.

File details

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

File metadata

  • Download URL: monaco-0.4.0-py3-none-any.whl
  • Upload date:
  • Size: 59.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.13 CPython/3.10.4 Linux/5.10.16.3-microsoft-standard-WSL2

File hashes

Hashes for monaco-0.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 2d5252f5f6960eaee35de1a22336a4ae91dbaacfb218dde2371c20a229f89f32
MD5 7f2853c543a0d34c39e8fd9ac6fffead
BLAKE2b-256 e5b10a6172551bc9964df16a7ccfbfe1bff3b7221e133fd9f0e3ce470a15d145

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