Metadata-Version: 1.1
Name: mcerp
Version: 0.9.1
Summary: Real-time latin-hypercube-sampling-based Monte Carlo Error Propagation
Home-page: https://github.com/tisimst/mcerp
Author: Abraham Lee
Author-email: tisimst@gmail.com
License: BSD License
Description: 
        ===============================
        ``mcerp`` Package Documentation
        ===============================
        
        Overview
        ========
        
        ``mcerp`` is an on-the-fly calculator for `Monte Carlo methods`_ that uses 
        `latin-hypercube sampling`_ (see `soerp`_ for the Python implementation of the
        analytical second-order error propagation original Fortran code 'SOERP' by 
        N. D. Cox) to perform non-order specific `error propagation`_ (or uncertainty
        analysis). The ``mcerp`` package allows you to **easily** and 
        **transparently** track the effects of uncertainty through mathematical 
        calculations. Advanced mathematical functions, similar to those in the 
        standard `math`_ module can also be evaluated directly. 
        
        Due to the nature of random sampling techniques, calculation results will vary 
        from session to session (but be consistent within the session) since new 
        latin-hypercube samples are only generated when variables are newly defined or 
        re-defined. By default, each variable uses 10,000 latin-hypercube samples that 
        are sufficiently random. The number of samples can be changed by assigning an 
        integer value to the ``mcerp.npts`` object (typically, values between 1,000 and 
        1,000,000 are sufficiently large to insure small errors in the resulting 
        statistics). This should only be changed prior to performing calculations since 
        all subsequent calculations assume that each input has the same number of 
        sampled points (this could be changed through resampling, I suppose...).
        
        In order to correctly use ``mcerp``, knowledge of the distributions from the 
        ``scipy.stats`` sub-module is required. The result of all calculations 
        generates a *mean*, *variance*, and *standardized skewness and kurtosis* 
        coefficients. 
        
        
        Required Packages
        =================
        
        - `NumPy`_ : Numeric Python
        
        - `SciPy`_ : Scientific Python
        
        Suggested Packages
        ==================
        
        - `Matplotlib`_ : Python plotting library (required for ``mcerp.plot``)
        
        Basic examples
        ==============
        
        Let's start with the main import::
        
            >>> from mcerp import *  # N, U, Gamma, Beta, etc.
        
        Now, we can construct many kinds of statistical distributions (both 
        continuous and discrete). Here's a basic example that involves a 
        three-part assembly::
        
            >>> x1 = N(24, 1) # normally distributed
            >>> x2 = N(37, 4) # normally distributed
            >>> x3 = Exp(2)  # exponentially distributed
            >>> x1.stats  # the first four moments can be accessed at any time
            [24.0, 1.0, 0.0, 3.0]
            
        Now we'll compute the actual stack-up using normal mathematics and see what 
        happens::
        
            >>> Z = (x1*x2**2)/(15*(1.5 + x3))
        
        We can see how the statistics of each of these distributions propagated 
        through the calculations in two basic ways:
        
        #. Telling python to print the object::
        
            >>> Z  # Explicit "print" command not necessary at the command-line
            uv(1161.14296871, 116093.134064, 0.361152281239, 3.05247793644)
        
        #. Using the ``describe`` class method (provides a more detailed explanation)::
        
            >>> Z.describe()
            MCERP Uncertain Value:
             > Mean...................  1161.14296871
             > Variance...............  116093.134064
             > Skewness Coefficient...  0.361152281239
             > Kurtosis Coefficient...  3.05247793644
        
        Viewing the distribution
        ------------------------
        
        We can also plot the calculated distribution using the ``plot`` class method::
        
            >>> x1.plot()  # No inputs shows the distribution's PDF
            >>> Z.plot(hist=True)  # shows a histogram instead of a PDF
        
        Correlations
        ------------
        
        Even correlations are correctly handled::
        
            >>> x1 - x1
            0.0
        
            >>> Z*Z - Z**2
            0.0
            
        Advanced Example
        ================
        
        Here's a *slightly* more advanced engineering example, showing how the 
        random effects of input parameters propagates through the calculation of 
        the volumetric gas flow through an orifice meter::
        
            >>> import mcerp.umath as umath  # sin, exp, sqrt, etc.
            >>> H = N(64, 0.5)
            >>> M = N(16, 0.1)
            >>> P = N(361, 2)
            >>> t = N(165, 0.5)
            >>> C = 38.4
            >>> Q = C*umath.sqrt((520*H*P)/(M*(t + 460)))
            >>> Q.describe()
            MCERP Uncertain Value:
             > Mean...................  1330.9997362
             > Variance...............  57.5497899824
             > Skewness Coefficient...  0.0229295468388
             > Kurtosis Coefficient...  2.99662898689
        
        Interestingly enough, even though the calculations involve multiplication, 
        division, and a square-root, the result appears to be very close to a Normal 
        (Gaussian) distribution (Q ~ N(1331, 7.6) where 7.6 = sqrt(58.2)).
        
        Using Distributions
        ===================
        
        Since all of the variables in ``mcerp`` are statistical distributions, they 
        are created using the ``scipy.stats`` distributions. There are also some 
        convenience constructors that should make defining a distribution easier, 
        though it's not necessary to use them. See the `source code`_ of the
        ``UncertainVariable`` class for info that describes how to construct many 
        of the most common statistical continuous and discrete distributions using 
        the ``scipy.stats`` distributions.
        
        Here are the **equivalent constructors** that I've found to be 
        **easier to use** (the location, scale, and shape parameters are described in 
        the respective Wikipedia pages):
        
        +----------------------------------------------------------------------------------+
        | **Continuous Distributions**                                                     |
        +-----------------------------------------+----------------------------------------+
        | ``N(mu, sigma)``                        | `Normal distribution`_                 |
        +-----------------------------------------+----------------------------------------+
        | ``U(a, b)``                             | `Uniform distribution`_                |
        +-----------------------------------------+----------------------------------------+
        | ``Exp(lamda, [mu])``                    | `Exponential distribution`_            |
        +-----------------------------------------+----------------------------------------+
        | ``Gamma(k, theta)``                     | `Gamma distribution`_                  |
        +-----------------------------------------+----------------------------------------+
        | ``Beta(alpha, beta, [a, b])``           | `Beta distribution`_                   |
        +-----------------------------------------+----------------------------------------+
        | ``LogN(mu, sigma)``                     | `Log-normal distribution`_             |
        +-----------------------------------------+----------------------------------------+
        | ``X2(k)``                               | `Chi-squared distribution`_            |
        +-----------------------------------------+----------------------------------------+
        | ``F(d1, d2)``                           | `F-distribution`_                      |
        +-----------------------------------------+----------------------------------------+
        | ``Tri(a, b, c)``                        | `Triangular distribution`_             |
        +-----------------------------------------+----------------------------------------+
        | ``T(v)``                                | `T-distribution`_                      |
        +-----------------------------------------+----------------------------------------+
        | ``Weib(lamda, k)``                      | `Weibull distribution`_                |
        +-----------------------------------------+----------------------------------------+
        | **Discrete Distributions**                                                       |
        +-----------------------------------------+----------------------------------------+
        | ``Bern(p)``                             | `Bernoulli distribution`_              |
        +-----------------------------------------+----------------------------------------+
        | ``B(n, p)``                             | `Binomial distribution`_               |
        +-----------------------------------------+----------------------------------------+
        | ``G(p)``                                | `Geometric distribution`_              |
        +-----------------------------------------+----------------------------------------+
        | ``H(M, n, N)``                          | `Hypergeometric distribution`_         |
        +-----------------------------------------+----------------------------------------+
        | ``Pois(lamda)``                         | `Poisson distribution`_                |
        +-----------------------------------------+----------------------------------------+
        
        For example, the following constructions are equivalent::
        
            # explicitly calling out the scipy.stats distribution
            >>> import scipy.stats as ss
            >>> x = uv(ss.norm(loc=10, scale=1))
        
            # using a built-in constructor
            >>> x = N(10, 1)
        
        From my experience, the first option can be tedious and difficult to work 
        with, but you make the choice. That's why there are options!
        
        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.
        
        Installation
        ============
        
        **Make sure you have the**  `SciPy`_ **and** `NumPy`_ **packages installed!**
        This package won't work without them.
        
        You have **several easy, convenient options** to install the ``mcerp`` 
        package (administrative privileges may be required)
        
        #. Simply copy the unzipped ``mcerp-XYZ`` directory to any other location that
           python can find it and rename it ``mcerp``.
            
        #. From the command-line, do one of the following:
           
           a. Manually download the package files below, unzip to any directory, and run::
           
               $ [sudo] python setup.py install
        
           b. If ``setuptools`` is installed, run::
        
               $ [sudo] easy_install --upgrade mcerp
            
           c. If ``pip`` is installed, run::
        
               $ [sudo] pip install --upgrade mcerp
        
        Python 3
        --------
        
        To use this package with Python 3.x, you will need to run the ``2to3`` 
        conversion tool at the command-line using the following syntax while in the 
        unzipped ``mcerp`` directory::
        
            $ 2to3 -w -f all *.py
            
        This should take care of the main changes required. Then, run::
        
            $ python3 setup.py install
        
        If bugs continue to pop up, please email the author.
            
        See also
        ========
        
        - `uncertainties`_ : First-order error propagation
        
        - `soerp`_ : Second-order error propagation
        
        Contact
        =======
        
        Please send **feature requests, bug reports, or feedback** to 
        `Abraham Lee`_.
        
        
            
        .. _Monte Carlo methods: http://en.wikipedia.org/wiki/Monte_Carlo_method
        .. _latin-hypercube sampling: http://en.wikipedia.org/wiki/Latin_hypercube_sampling
        .. _soerp: http://pypi.python.org/pypi/soerp
        .. _error propagation: http://en.wikipedia.org/wiki/Propagation_of_uncertainty
        .. _math: http://docs.python.org/library/math.html
        .. _NumPy: http://www.numpy.org/
        .. _SciPy: http://scipy.org
        .. _Matplotlib: http://matplotlib.org/
        .. _uncertainties: http://pypi.python.org/pypi/uncertainties
        .. _source code: https://github.com/tisimst/mcerp
        .. _Abraham Lee: mailto:tisimst@gmail.com
        .. _Normal distribution: http://en.wikipedia.org/wiki/Normal_distribution
        .. _Uniform distribution: http://en.wikipedia.org/wiki/Uniform_distribution_(continuous)
        .. _Exponential distribution: http://en.wikipedia.org/wiki/Exponential_distribution
        .. _Gamma distribution: http://en.wikipedia.org/wiki/Gamma_distribution
        .. _Beta distribution: http://en.wikipedia.org/wiki/Beta_distribution
        .. _Log-normal distribution: http://en.wikipedia.org/wiki/Log-normal_distribution
        .. _Chi-squared distribution: http://en.wikipedia.org/wiki/Chi-squared_distribution
        .. _F-distribution: http://en.wikipedia.org/wiki/F-distribution
        .. _Triangular distribution: http://en.wikipedia.org/wiki/Triangular_distribution
        .. _T-distribution: http://en.wikipedia.org/wiki/Student's_t-distribution
        .. _Weibull distribution: http://en.wikipedia.org/wiki/Weibull_distribution
        .. _Bernoulli distribution: http://en.wikipedia.org/wiki/Bernoulli_distribution
        .. _Binomial distribution: http://en.wikipedia.org/wiki/Binomial_distribution
        .. _Geometric distribution: http://en.wikipedia.org/wiki/Geometric_distribution
        .. _Hypergeometric distribution: http://en.wikipedia.org/wiki/Hypergeometric_distribution
        .. _Poisson distribution: http://en.wikipedia.org/wiki/Poisson_distribution
            
Keywords: monte carlo,latin hypercube,sampling calculator,error propagation,uncertainty,error,real-time
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: Environment :: MacOS X
Classifier: Environment :: Win32 (MS Windows)
Classifier: Environment :: X11 Applications
Classifier: Intended Audience :: Customer Service
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Education
Classifier: Intended Audience :: Financial and Insurance Industry
Classifier: Intended Audience :: Healthcare Industry
Classifier: Intended Audience :: Manufacturing
Classifier: Intended Audience :: Other Audience
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: BSD License
Classifier: Natural Language :: English
Classifier: Operating System :: MacOS
Classifier: Operating System :: Microsoft
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: OS Independent
Classifier: Operating System :: POSIX
Classifier: Operating System :: Unix
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.0
Classifier: Programming Language :: Python :: 3.1
Classifier: Programming Language :: Python :: 3.2
Classifier: Programming Language :: Python :: 3.3
Classifier: Topic :: Education
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Scientific/Engineering :: Chemistry
Classifier: Topic :: Scientific/Engineering :: Electronic Design Automation (EDA)
Classifier: Topic :: Scientific/Engineering :: Information Analysis
Classifier: Topic :: Scientific/Engineering :: Mathematics
Classifier: Topic :: Scientific/Engineering :: Physics
Classifier: Topic :: Software Development
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Utilities
