soerp3 0.9.7__tar.gz

soerp3-0.9.7/.gitignore

@@ -0,0 +1,207 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+#poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+#pdm.lock
+#pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+#pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# Abstra
+# Abstra is an AI-powered process automation framework.
+# Ignore directories containing user credentials, local state, and settings.
+# Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#  Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#  that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#  and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#  you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Cursor
+#  Cursor is an AI-powered code editor. `.cursorignore` specifies files/directories to
+#  exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
+#  refer to https://docs.cursor.com/context/ignore-files
+.cursorignore
+.cursorindexingignore
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/

soerp3-0.9.7/.python-version

@@ -0,0 +1 @@
+3.13

soerp3-0.9.7/LICENSE

@@ -0,0 +1,30 @@
+BSD 3-Clause License
+
+Copyright (c) 2010 - 2018, Abraham Lee
+Copyright (c) 2026, eggzec
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

soerp3-0.9.7/PKG-INFO

@@ -0,0 +1,336 @@
+Metadata-Version: 2.4
+Name: soerp3
+Version: 0.9.7
+Summary: Second Order Error Propagation for Python
+Project-URL: homepage, https://eggzec.github.io/soerp3/
+Project-URL: documentation, https://eggzec.github.io/soerp3/
+Project-URL: source, https://github.com/eggzec/soerp3
+Project-URL: releasenotes, https://github.com/eggzec/soerp3/releases/latest
+Project-URL: issues, https://github.com/eggzec/soerp3/issues
+Author-email: Abraham Lee <tisimst@gmail.com>
+Maintainer-email: Saud Zahir <m.saud.zahir@gmail.com>, M Laraib Ali <laraibg786@outlook.com>
+License-Expression: BSD-3-Clause
+License-File: LICENSE
+Keywords: derivative,distribution,error propagation,method of moments,second order,statistics,uncertainties,uncertainty analysis
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Education
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Operating System :: MacOS
+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 :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Education
+Classifier: Topic :: Scientific/Engineering
+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
+Requires-Python: >=3.10
+Requires-Dist: matplotlib
+Requires-Dist: numpy
+Requires-Dist: scipy
+Description-Content-Type: text/x-rst
+
+===============================
+``soerp`` Package Documentation
+===============================
+
+Overview
+========
+
+``soerp`` is the Python implementation of the original Fortran code `SOERP` 
+by N. D. Cox to apply a second-order analysis to `error propagation`_ (or 
+uncertainty analysis). The ``soerp`` 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.
+
+In order to correctly use ``soerp``, the **first eight statistical moments** 
+of the underlying distribution are required. These are the *mean*, *variance*, 
+and then the *standardized third through eighth moments*. These can be input 
+manually in the form of an array, but they can also be **conveniently 
+generated** using either the **nice constructors** or directly by using the 
+distributions from the ``scipy.stats`` sub-module. See the examples below for 
+usage examples of both input methods. The result of all calculations generates a 
+*mean*, *variance*, and *standardized skewness and kurtosis* coefficients.
+
+
+Required Packages
+=================
+
+- ad_ : For first- and second-order automatic differentiation (install this first).
+
+- NumPy_ : Numeric Python
+
+- SciPy_ : Scientific Python (the nice distribution constructors require this)
+
+- Matplotlib_ : Python plotting library
+
+Basic examples
+==============
+
+Let's begin by importing all the available constructors::
+
+    >>> from soerp import *   # uv, N, U, Exp, etc.
+
+Now, we can see that there are several equivalent ways to specify a statistical distribution, say a Normal distribution with a mean value of 10 and a standard deviation of 1:
+
+- Manually input the first 8 moments (mean, variance, and 3rd-8th standardized central moments)::
+
+    >>> x = uv([10, 1, 0, 3, 0, 15, 0, 105])
+
+- Use the ``rv`` kwarg to input a distribution from the ``scipy.stats`` module::
+
+    >>> x = uv(rv=ss.norm(loc=10, scale=1))
+
+- Use a built-in convenience constructor (typically the easiest if you can)::
+
+    >>> x = N(10, 1)
+
+A Simple Example
+----------------
+
+Now let's walk through an example of a three-part assembly stack-up::
+
+    >>> x1 = N(24, 1)  # normally distributed
+    >>> x2 = N(37, 4)  # normally distributed
+    >>> x3 = Exp(2)  # exponentially distributed
+    >>> Z = (x1*x2**2)/(15*(1.5 + x3))
+
+We can now see the results of the calculations in two ways:
+
+#. The usual ``print`` statement (or simply the object if in a terminal)::
+
+    >>> Z  # "print" is optional at the command-line
+    uv(1176.45, 99699.6822917, 0.708013052944, 6.16324345127)
+
+#. The ``describe`` class method that explains briefly what the values are::
+
+    >>> Z.describe()
+    SOERP Uncertain Value:
+     > Mean...................  1176.45
+     > Variance...............  99699.6822917
+     > Skewness Coefficient...  0.708013052944
+     > Kurtosis Coefficient...  6.16324345127
+
+Distribution Moments
+--------------------
+
+The eight moments of any input variable (and four of any output variable) can be accessed using the ``moments`` class method, as in::
+
+    >>> x1.moments()
+    [24.0, 1.0, 0.0, 3.0000000000000053, 0.0, 15.000000000000004, 0.0, 105.0]
+    >>> Z.moments()
+    [1176.45, 99699.6822917, 0.708013052944, 6.16324345127]
+
+Correlations
+------------
+
+Statistical correlations are correctly handled, even after calculations have taken place::
+
+    >>> x1 - x1
+    0.0
+    >>> square = x1**2
+    >>> square - x1*x1
+    0.0
+
+Derivatives
+-----------
+
+Derivatives with respect to original variables are calculated via the ad_ package and are accessed using the **intuitive class methods**::
+
+    >>> Z.d(x1)  # dZ/dx1
+    45.63333333333333
+
+    >>> Z.d2(x2)  # d^2Z/dx2^2
+    1.6
+
+    >>> Z.d2c(x1, x3)  # d^2Z/dx1dx3 (order doesn't matter)
+    -22.816666666666666
+    
+When we need multiple derivatives at a time, we can use the ``gradient`` and ``hessian`` class methods::
+
+    >>> Z.gradient([x1, x2, x3])
+    [45.63333333333333, 59.199999999999996, -547.6]
+
+    >>> Z.hessian([x1, x2, x3])
+    [[0.0, 2.466666666666667, -22.816666666666666], [2.466666666666667, 1.6, -29.6], [-22.816666666666666, -29.6, 547.6]]
+
+Error Components/Variance Contributions
+---------------------------------------
+
+Another useful feature is available through the ``error_components`` class method that has various ways of representing the first- and second-order variance components::
+
+    >>> Z.error_components(pprint=True)
+    COMPOSITE VARIABLE ERROR COMPONENTS
+    uv(37.0, 16.0, 0.0, 3.0) = 58202.9155556 or 58.378236%
+    uv(24.0, 1.0, 0.0, 3.0) = 2196.15170139 or 2.202767%
+    uv(0.5, 0.25, 2.0, 9.0) = -35665.8249653 or 35.773258%
+
+Advanced Example
+----------------
+
+Here's a *slightly* more advanced example, estimating the statistical properties of volumetric gas flow through an orifice meter::
+
+    >>> from soerp.umath import *  # 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()
+    SOERP Uncertain Value:
+     > Mean...................  1330.99973939
+     > Variance...............  58.210762839
+     > Skewness Coefficient...  0.0109422068056
+     > Kurtosis Coefficient...  3.00032693502
+ 
+This seems to indicate that even though there are products, divisions, and the usage of ``sqrt``, the result resembles a normal distribution (i.e., Q ~ N(1331, 7.63), where the standard deviation = sqrt(58.2) = 7.63).
+
+Main Features
+=============
+
+1. **Transparent calculations** with derivatives automatically calculated. 
+   **No or little modification** to existing code required.
+
+2. Basic `NumPy` support without modification. Vectorized calculations built-in  
+   to the ``ad`` package.
+
+3. Nearly all standard `math`_ module functions supported through the 
+   ``soerp.umath`` sub-module. If you think a function is in there, it probably 
+   is.
+
+4. Nearly all derivatives calculated analytically using ``ad`` functionality.
+
+5. **Easy continuous distribution constructors**: 
+
+   - ``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`_
+
+   - ``Chi2(k)`` : `Chi-squared distribution`_
+
+   - ``F(d1, d2)`` : `F-distribution`_
+
+   - ``Tri(a, b, c)`` : `Triangular distribution`_
+
+   - ``T(v)`` : `T-distribution`_
+
+   - ``Weib(lamda, k)`` : `Weibull distribution`_
+
+   The location, scale, and shape parameters follow the notation in the 
+   respective Wikipedia articles. *Discrete distributions are not recommended 
+   for use at this time. If you need discrete distributions, try the* mcerp_ 
+   *python package instead.*
+
+Installation
+============
+
+**Make sure you install the** `ad`_ **package first!** (If you use options 
+3 or 4 below, this should be done automatically.)
+
+You have several easy, convenient options to install the ``soerp`` package 
+(administrative privileges may be required)
+
+1. Download the package files below, unzip to any directory, and run::
+
+    $ [sudo] python setup.py install
+   
+2. Simply copy the unzipped ``soerp-XYZ`` directory to any other location that 
+   python can find it and rename it ``soerp``.
+   
+3. If ``setuptools`` is installed, run::
+
+    $ [sudo] easy_install [--upgrade] soerp
+   
+4. If ``pip`` is installed, run::
+
+    $ [sudo] pip install [--upgrade] soerp
+    
+Uninstallation
+==============
+
+To remove the package, there are really two good ways to do this:
+
+1. Go to the folder ``site-packages`` or ``dist-packages`` and simply delete
+   the folder ``soerp`` and ``soerp-XYZ-egg-info``.
+
+2. If ``pip`` is installed, run::
+
+    $ [sudo] pip uninstall soerp
+
+See Also
+========
+
+- uncertainties_ : First-order error propagation
+
+- mcerp_ : Real-time latin-hypercube sampling-based Monte Carlo error 
+  propagation
+
+Contact
+=======
+
+Please send **feature requests, bug reports, or feedback** to 
+`Abraham Lee`_.
+
+Acknowledgements
+================
+
+The author wishes to thank `Eric O. LEBIGOT`_ who first developed the
+`uncertainties`_ python package (for first-order error propagation), 
+from which many inspiring ideas (like maintaining object correlations, etc.) 
+are re-used and/or have been slightly evolved. *If you don't need second
+order functionality, his package is an excellent alternative since it is
+optimized for first-order uncertainty analysis.*
+
+References
+==========
+
+- N.D. Cox, 1979, *Tolerance Analysis by Computer*, Journal of Quality Technology, Vol. 11, No. 2, pp. 80-87
+
+
+
+.. _error propagation: http://en.wikipedia.org/wiki/Propagation_of_uncertainty
+.. _math: http://docs.python.org/library/math.html
+.. _ad: http://pypi.python.org/pypi/ad
+.. _mcerp: http://pypi.python.org/pypi/mcerp
+.. _NumPy: http://www.numpy.org/
+.. _SciPy: http://scipy.org
+.. _Matplotlib: http://matplotlib.org/
+.. _uncertainties: http://pypi.python.org/pypi/uncertainties
+.. _Abraham Lee: mailto: tisimst@gmail.com
+.. _Eric O. LEBIGOT: http://www.linkedin.com/pub/eric-lebigot/22/293/277
+.. _PEP8: http://www.python.org/dev/peps/pep-0008
+.. _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