Skip to content

Latest commit

 

History

History
130 lines (91 loc) · 4.38 KB

README.rst

File metadata and controls

130 lines (91 loc) · 4.38 KB
Raw

mcerp3 Package Documentation

Overview

mcerp3 is a stochastic calculator for Monte Carlo methods that uses latin-hypercube sampling to perform non-order specific error propagation (or uncertainty analysis).

With this package you can easily and transparently track the effects of uncertainty through mathematical calculations. Advanced mathematical functions, similar to those in the standard math module, and statistical functions like those in the scipy.stats module, can also be evaluated directly.

If you are familiar with Excel-based risk analysis programs like @Risk, Crystal Ball, ModelRisk, etc., this package will work wonders for you (and probably even be faster!) and give you more modelling flexibility with the powerful Python language. This package also doesn't cost a penny, compared to those commercial packages which cost thousands of dollars for a single-seat license. Feel free to copy and redistribute this package as much as you desire!

What's New In This Release

  • this is a Python 3 release of the mcerp package by Abraham Lee
  • officially adds the 3-clause BSD licesnse text to the software (this license has been specified in the mcerp PyPI package for years)

Main Features

  1. Transparent calculations. No or little modification to existing code required.
  2. Basic NumPy support without modification. (I haven't done extensive testing, so please let me know if you encounter bugs.)
  3. Advanced mathematical functions supported through the mcerp.umath sub-module. If you think a function is in there, it probably is. If it isn't, please request it!
  4. Easy statistical distribution constructors. The location, scale, and shape parameters follow the notation in the respective Wikipedia articles and other relevant web pages.
  5. Correlation enforcement and variable sample visualization capabilities.
  6. Probability calculations using conventional comparison operators.
  7. Advanced Scipy statistical function compatibility with package functions. Depending on your version of Scipy, some functions might not work.
  8. Python 3 support

Installation

Required Packages

The following packages should be installed automatically (if using pip or easy_install), otherwise they will need to be installed manually:

These packages come standard in Python(x,y), Spyder, and other scientific computing python bundles.

How to install

You have several easy, convenient options to install the mcerp3 package (administrative privileges may be required)

  1. Simply copy the unzipped mcerp3-XYZ directory to any other location that python can find it and rename it mcerp3.

  2. From the command-line, do one of the following:

    1. Manually download the package files below, unzip to any directory, and run:

      $ [sudo] python setup.py install

    2. If setuptools is installed, run:

      $ [sudo] easy_install [--upgrade] mcerp3

    3. If pip is installed, run:

      $ [sudo] pip install [--upgrade] mcerp3

See also

Contact

Please send Python 3 related issues to Paul Freeman. Other issues should be referred to the original author, Abraham Lee.