Skip to main content

L-Moments for robust statistics & inference.

Project description

Lmo - Trimmed L-moments and L-comoments

GitHub Workflow Status license Lmo - PyPI Lmo - Versions Ruff Pyright

Unlike the legacy product-moments, the L-moments uniquely describe a probability distribution, and are more robust and efficient.

The "L" stands for Linear; it is a linear combination of order statistics. So Lmo is as fast as sorting your samples (in terms of time-complexity).

Key Features

  • Calculates trimmed L-moments and L-comoments, from samples or any scipy.stats distribution.
  • Full support for trimmed L-moment (TL-moments), e.g. lmo.l_moment(..., trim=(1/137, 3.1416)).
  • Generalized Method of L-moments: robust distribution fitting that beats MLE.
  • Fast estimation of L-comoment matrices from your multidimensional data or multivariate distribution.
  • Goodness-of-fit test, using L-moment or L-moment ratio's.
  • Exact (co)variance structure of the sample- and population L-moments.
  • Theoretical & empirical influence functions of L-moments & L-ratio's.
  • Complete docs, including detailed API reference with usage examples and with mathematical $\TeX$ definitions.
  • Clean Pythonic syntax for ease of use.
  • Vectorized functions for very fast fitting.
  • Fully typed, tested, and tickled.
  • Optional Pandas integration.

Quick example

Even if your data is pathological like Cauchy, and the L-moments are not defined, the trimmed L-moments (TL-moments) can be used instead. Let's calculate the TL-location and TL-scale of a small amount of samples:

>>> import numpy as np
>>> import lmo
>>> rng = np.random.default_rng(1980)
>>> x = rng.standard_cauchy(96)  # pickle me, Lmo
>>> lmo.l_moment(x, [1, 2], trim=(1, 1)).
array([-0.17937038,  0.68287665])

Now compare with the theoretical standard Cauchy TL-moments:

>>> from scipy.stats import cauchy
>>> cauchy.l_moment([1, 2], trim=(1, 1))
array([0.        , 0.69782723])

See the documentation for more examples and the API reference.

Roadmap

  • Automatic trim-length selection.
  • Plotting utilities (deps optional), e.g. for L-moment ratio diagrams.

Installation

Lmo is on PyPI, so you can do something like:

pip install lmo

Required dependencies

These are automatically installed by your package manager, alongside lmo.

Package Minimum version
Python 3.10
NumPy See NEP 29
SciPy 1.9

Optional dependencies

Package Minimum version Notes
Pandas 1.4 Installable as lmo[pandas]

Foundational Literature

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

lmo-0.13.1.tar.gz (91.0 kB view details)

Uploaded Source

Built Distribution

lmo-0.13.1-py3-none-any.whl (97.3 kB view details)

Uploaded Python 3

File details

Details for the file lmo-0.13.1.tar.gz.

File metadata

  • Download URL: lmo-0.13.1.tar.gz
  • Upload date:
  • Size: 91.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.2 CPython/3.11.5 Linux/6.8.0-76060800daily20240311-generic

File hashes

Hashes for lmo-0.13.1.tar.gz
Algorithm Hash digest
SHA256 e535eed7fe056ceabdc4f50a4b9ec54a4744564ec013351eed6e0849ebbaed06
MD5 a0126cc7ab3d6861b33823188bce2a20
BLAKE2b-256 e08b03a5189521bbd458ec7e5c0addacfee503e398713afcf93b27d6c528ac29

See more details on using hashes here.

File details

Details for the file lmo-0.13.1-py3-none-any.whl.

File metadata

  • Download URL: lmo-0.13.1-py3-none-any.whl
  • Upload date:
  • Size: 97.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.2 CPython/3.11.5 Linux/6.8.0-76060800daily20240311-generic

File hashes

Hashes for lmo-0.13.1-py3-none-any.whl
Algorithm Hash digest
SHA256 8d5b93eaec38f280052295af3b811af42abe21b75f56bba461d19934a37c96e2
MD5 4f9bb1ecf5bc061f2b7b49a634421f65
BLAKE2b-256 223aa279b87013a2ed126a6c8dbb292de5c73e2ebcbc298d5d8fad5044f606ea

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