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

Dependencies

These are automatically installed by your package manager when installing Lmo.

Package Supported versions
Python >=3.10
NumPy >=1.23
SciPy >=1.9

Additionally, Lmo supports the following optional packages:

Package Supported versions Installation
Pandas >=1.5 pip install Lmo[pandas]

See SPEC 0 for more information.

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.14.0.tar.gz (95.0 kB view details)

Uploaded Source

Built Distribution

lmo-0.14.0-py3-none-any.whl (102.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: lmo-0.14.0.tar.gz
  • Upload date:
  • Size: 95.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.12.3 Linux/6.8.0-76060800daily20240311-generic

File hashes

Hashes for lmo-0.14.0.tar.gz
Algorithm Hash digest
SHA256 2fdc190442a953c2fe795206408eedee9ef1a84f8e5420d749b828dce417cdb4
MD5 6c3d7f9c7fceaaee3e0be46b2480ccd8
BLAKE2b-256 85c48cd40b1b6358052049b35009f7ba894e11c79e13e52a6a91b5ec9232fc69

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for lmo-0.14.0-py3-none-any.whl
Algorithm Hash digest
SHA256 7688bfb41aba020bdf8a861e69ba0408d2139781474396c2a77e9aa8aeef821a
MD5 a7175c4ae1702ffc23a3c82084cebb8c
BLAKE2b-256 3ca24acb167dc071ebcbd0b0d8271d73cb83a65163921899a4c439c6466bb054

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