Skip to main content

L-Moments for robust statistics.

Project description

jorenham/lmo

Lmo - Trimmed L-moments and L-comoments

license PyPI PyPI - Downloads versions GitHub Workflow Status (with branch) GitHub commit activity (branch)


Is your tail too heavy?
Can't find a moment?
Are the swans black?
The distribution pathological?

... then look no further: Lmo's got you covered!

Uniform or multi-dimensional, Lmo can summarize it all with one quick glance!

Unlike the legacy moments, 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 1.22
SciPy 1.9

Optional dependencies

Package Minimum version Notes
Pandas 1.4 Lmo extends pd.Series and pd.DataFrame with convenient methods, e.g. df.l_scale(trim=1). Install as pip install lmo[pandas] to ensure compatibility.

Foundational Literature

Project details


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

Uploaded Source

Built Distribution

lmo-0.12.1-py3-none-any.whl (97.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: lmo-0.12.1.tar.gz
  • Upload date:
  • Size: 91.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.7.1 CPython/3.11.5 Linux/6.6.6-76060606-generic

File hashes

Hashes for lmo-0.12.1.tar.gz
Algorithm Hash digest
SHA256 432f3e68928f2a796a36b2c706e85b8be17c0741ffb84391ec0cbdba077a4029
MD5 afc5cb27f172461ee0552a4cb61b9294
BLAKE2b-256 c464001777ccee46e70565f6e983068dbff33b8f1309b678d7c074b0c8519caa

See more details on using hashes here.

File details

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

File metadata

  • Download URL: lmo-0.12.1-py3-none-any.whl
  • Upload date:
  • Size: 97.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.7.1 CPython/3.11.5 Linux/6.6.6-76060606-generic

File hashes

Hashes for lmo-0.12.1-py3-none-any.whl
Algorithm Hash digest
SHA256 8c836f471a131383ea8aba870b1949b8595e7438b33aa413edb7b6c1514a7e92
MD5 ba4f310d4e3714e6648bf44434ebcd60
BLAKE2b-256 f01929c98e99c6c89f8c47dc03b36f4feb8ae2a737155615917c4162478b83a2

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