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 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

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

Uploaded Source

Built Distribution

monaco-0.8.0-py3-none-any.whl (68.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: monaco-0.8.0.tar.gz
  • Upload date:
  • Size: 63.2 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.8.0.tar.gz
Algorithm Hash digest
SHA256 d66b8eb752616756d4741b830ccf36e31fb4e023140eaf2f8a347b68c1f2c5d4
MD5 efc34649299654e10592e72df75f73a6
BLAKE2b-256 0e2a9af1f3058b93e0d6f4edcfbb5b241ded29fe71578f43a087af5e7fc7aa2b

See more details on using hashes here.

File details

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

File metadata

  • Download URL: monaco-0.8.0-py3-none-any.whl
  • Upload date:
  • Size: 68.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.8.0-py3-none-any.whl
Algorithm Hash digest
SHA256 bc3fb5c5b6e41a96e3b6e98ea28eb0d9afaa10c027850dae8f7218d4bb2d4808
MD5 4934e88c678eafb7b36a15e9af349135
BLAKE2b-256 044b75868a69f4111dc64c6955a493a83b49caf3c673b0118718b16c7fdb949d

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