scottshambaugh / monaco

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

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

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

About

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

License:MIT License


Languages

Language:Python 96.6%Language:Jupyter Notebook 3.3%Language:TeX 0.1%