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

Uploaded Source

Built Distribution

lmo-0.11.3-py3-none-any.whl (85.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: lmo-0.11.3.tar.gz
  • Upload date:
  • Size: 79.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.7.1 CPython/3.11.5 Linux/6.5.6-76060506-generic

File hashes

Hashes for lmo-0.11.3.tar.gz
Algorithm Hash digest
SHA256 3928d87e98e0a724f86a78e297d9d7473a2632c3f51b3da339fea627e738a4ef
MD5 b2e8a327dc9348c2ce53220d624a5a96
BLAKE2b-256 3706a33d65c430516c7ddeb4e7839b71ddf35f1404d973997e567bc888e35e01

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for lmo-0.11.3-py3-none-any.whl
Algorithm Hash digest
SHA256 9bbf2f5c69125b4f35b3b469d2ce54deb66b53d9cefec015ea9835e10f44ee98
MD5 595cb0dd8fc05a94dbf85dcac65af1e5
BLAKE2b-256 39607a4b455780443e3ca2284d11810d1295120b01944011417bb1deadd71534

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