Skip to main content

nsevt

nsevt — non-stationary extreme-value tail inference

CI PyPI Python versions License: MIT DOI

The current release is nsevt 1.0.2. Install the exact version with pip install nsevt==1.0.2. Its archived release is available at Zenodo (DOI 10.5281/zenodo.21958106).

nsevt is a dependency-light Python package for seven connected tasks:

  1. peaks-over-threshold generalized Pareto (GPD) estimation with an adaptive profile-likelihood interval for the shape and a bootstrap of the finite endpoint;
  2. an interval-censored (grouped) GPD fit for discretised data, with profile-likelihood intervals for the shape and the endpoint, which removes the bias that rounding induces in both;
  3. a likelihood-ratio trend test calibrated by complete-block label permutation, with an interpolated minimum-detectable effect reported together with its underlying effect grid;
  4. Monte Carlo power and signed minimum-detectable-effect (MDE) analysis;
  5. a sequential Monte Carlo precision protocol that reports the simulation error of every Monte Carlo estimate and grows a run until its MCSE, estimate and qualitative decision have all stabilised;
  6. a finite-sample calibration suite that measures the empirical type-I error, power, interval coverage and bias/RMSE of any estimator or test on your own data generating process; and
  7. a pre-specified multi-source robustness analysis that distinguishes non-reproduction with adequate power from an unresolved comparison.

The package uses deliberately measured terminology. A negative GPD shape point estimate gives a finite model-conditional statistical endpoint. nsevt reports support for a negative shape only when the entire 95% profile interval lies below zero; neither result is called a physical ceiling.

Install

From PyPI:

pip install nsevt

For development or the optional Streamlit demonstration:

git clone https://github.com/GaiskaSalomon/nsevt.git
cd nsevt
pip install -e ".[dev,demo]"

Quick start

import numpy as np
import nsevt

rng = np.random.default_rng(7)
threshold, xi, sigma = 40.0, -0.25, 10.0
years = np.repeat(np.arange(1980, 2030), 12)
uniform = rng.uniform(size=years.size)
excess = sigma / xi * ((1 - uniform) ** (-xi) - 1)
values = threshold + excess

fit = nsevt.gpd_pot(values, threshold=threshold, n_boot=300)
print(fit.summary())
print("negative-shape estimate:", fit.bounded_estimate)
print("negative shape supported by 95% CI:", fit.bounded_supported)

trend = nsevt.trend_permutation(excess, years, n_perm=999)
print("LR permutation p:", trend["p_permutation"],
      "+/-", trend["p_permutation_mcse"])

mde = nsevt.min_detectable_effect(
    excess, years, direction="both", n_rep=200, n_perm_calibration=499
)
print("positive MDE:", mde["mde_positive"])
print("negative MDE:", mde["mde_negative"])
print("interpolated EMD:", mde["emd_positive"], mde["emd_positive_ci95"])

Discretised (grouped) data

When values are recorded on a grid (for example wind speeds in 5 kt steps), fitting the continuous GPD to the rounded values biases the shape and the finite endpoint. gpd_pot_grouped fits the interval-censored likelihood instead and reports a profile-likelihood interval for both the shape and the endpoint (the endpoint interval profiles the reparameterised endpoint, not a percentile bootstrap).

fit = nsevt.gpd_pot_grouped(values, threshold=40, grid=5.0)
print(fit.summary())
print("shape 95% CI:", fit.xi_ci95)
print("endpoint 95% CI:", fit.endpoint_ci95)

Multi-source robustness

Sources must be genuinely distinct products with comparable temporal support; early and late halves of one record are not substitutes.

result = nsevt.multisource_robustness(
    [("product A", values_a, years_a),
     ("product B", values_b, years_b)],
    threshold=40,
    reference="product A",
)
print(result.trend_status)
print(result.table())

Possible trend statuses include reproduced, inconsistent_direction, not_reproduced_with_power, not_resolved, and no_reference_signal. Agreement or disagreement across sources is a robustness result; it does not by itself attribute a discrepancy to instruments, homogenization, or physical change.

Monte Carlo precision

Any power, coverage, permutation p-value or bootstrap interval is itself a Monte Carlo estimate with a simulation error. nsevt.mc reports that error and grows a run in blocks until the Monte Carlo standard error, the estimate and every registered qualitative decision have all stabilised, rather than trusting a fixed replicate budget. It depends only on NumPy and is estimator-agnostic: you supply the replicate outcomes.

from nsevt import mc

streams = mc.block_streams(seed=20260814, n_blocks=64)

def draw(k, block_index):                       # k rejection indicators
    rng = streams[block_index]
    return (rng.random(k) < 0.8).astype(float)   # e.g. a power study

run = mc.run_sequential("power", draw, kind="proportion", epsilon=0.0025)
s = run.summary()
print(s["status"], s["R_star"], s["estimate"], s["mcse"])

required_replicates(0.80, 0.0025) reports the 25,600 replicates such a target needs, and permutation_pvalue returns the floor-aware (1 + #exceed) / (B + 1). At observed proportions of exactly zero or one, the MCSE uses a Jeffreys half-count rather than reporting zero simulation error.

Finite-sample calibration

nsevt.calibration checks whether a method's asymptotic guarantees actually hold at your sample size and under your data generating process. You pass a simulate(rng, n) callable and your estimator or test; the suite measures the empirical type-I error or power (rejection_rate), interval coverage (coverage), and bias/RMSE (bias_rmse). Under a misspecified DGP an estimator may converge to a pseudo-true value rather than the generating parameter. pseudo_true provides a large-sample Monte Carlo proxy for that target so coverage and bias can be assessed against an explicit, reproducible reference. It is one large-sample fit, not proof of a limiting value; check increasing sample sizes and independent seeds before treating it as a target.

from nsevt import calibration as cal

def simulate(rng, n):                     # your data generating process
    u = rng.uniform(size=n)
    return 15.0 / -0.2 * ((1 - u) ** 0.2 - 1)      # GPD(xi=-0.2, sigma=15)

def interval(sample):
    _, _, ci = nsevt.profile_ci_xi(sample)
    return ci

cov = cal.coverage(interval, simulate, n=400, target=-0.2, level=0.95,
                   epsilon=0.01, r0=1000, r_min=1000, block=500)
print(cov["coverage"], cov["mcse"], cov["status"])

The proportion analyses run on the sequential protocol above, so each reports its Monte Carlo standard error and whether it stabilised.

Grouped regression and return levels

nsevt.design extends the grouped fit from a single scale to a log-linear scale design, and adds return levels. fit_grouped_design takes a design matrix (a trend column, group indicators, or any combination); profile_ci_coef gives a profile-likelihood interval for any coefficient — the interval counterpart of the permutation trend test. return_level and profile_ci_return_level give the level exceeded once per m observations at an exceedance rate, with a profile interval obtained by profiling the level itself.

from nsevt import design
import numpy as np

X = np.column_stack([np.ones(marks.size), decade])   # intercept + a trend column
fit = design.fit_grouped_design(marks, threshold=40, design=X, grid=5.0)
ci = design.profile_ci_coef(marks, 40, X, coef=1, grid=5.0)   # trend interval
print(fit["coef"][1], ci["ci"])

rl = design.profile_ci_return_level(marks, 40, rate=0.4, m=100, grid=5.0)
print(rl["return_level"], rl["ci"])

Stable and experimental functionality

As of 1.0.0 the public API is stable: the modules listed as stable below — their names, signatures, and documented return schemas — are frozen, and a backward-incompatible change to them will require a 2.0.0. Additions remain minor (1.x) changes. The nsevt.experimental routines are outside this guarantee.

status module purpose
stable nsevt.gpd GPD fit, profile interval, conditional endpoint bootstrap, return levels
stable nsevt.grouped interval-censored (grouped) GPD fit; profile intervals for shape and endpoint
stable nsevt.trend LR block-label permutation, power/MDE, descriptive block-bootstrap interval
stable nsevt.mc sequential Monte Carlo precision: MCSE, stopping rule, traces, reproducible substreams
stable nsevt.calibration finite-sample type-I/power, coverage, bias/RMSE and pseudo-true target
stable nsevt.design grouped GPD regression (covariate scale), coefficient profile CI, return levels
stable nsevt.transportability multi-source robustness and power-aware status
stable with assumptions split_conformal upper tail bound for exchangeable calibration scores
experimental block_conformal block-aggregate dependence sensitivity diagnostic
experimental twoscale_trend residual-bootstrap distribution-valued trend diagnostic
experimental wasserstein_decomposition numerical quantile-grid energy decomposition

The exact assumptions and claim boundaries are documented in docs/assumptions.md. The experimental routines are collected under nsevt.experimental (still importable from the top level for backward compatibility) and are outside the public-API stability guarantee.

Reproducibility and tests

The implementation was adapted from research pipelines and then regression- checked; it is not represented as a verbatim copy. Randomized routines accept a seed and report the number of successful replicates. Run the validation suite with:

pip install -e ".[dev]"
ruff check src tests demo
pytest --cov=nsevt --cov-report=term-missing --cov-fail-under=80
python -m build
python -m twine check dist/*

See docs/validation.md for what each test establishes and, equally importantly, what it does not establish.

Citation and license

Use CITATION.cff or the Zenodo DOI shown above. nsevt is released under the MIT License; see LICENSE.

Download files

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

Source Distribution

nsevt-1.0.2.tar.gz (80.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

nsevt-1.0.2-py3-none-any.whl (47.3 kB view details)

Uploaded Python 3

File details

Details for the file nsevt-1.0.2.tar.gz.

File metadata

  • Download URL: nsevt-1.0.2.tar.gz
  • Upload date:
  • Size: 80.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/7.0.0 CPython/3.14.6

File hashes

Hashes for nsevt-1.0.2.tar.gz
Algorithm Hash digest
SHA256 c0aa94ab96889a39151e65ecfb5960d89513535dd06c5be2a9a1cc6ecc0c9fa7
MD5 73f5a5c1e141ee41a68b5eb60fd2ac41
BLAKE2b-256 9be195fd9a95efddc981f8128309a76284f24a89033b7d49628a316f3016723d

See more details on using hashes here.

File details

Details for the file nsevt-1.0.2-py3-none-any.whl.

File metadata

  • Download URL: nsevt-1.0.2-py3-none-any.whl
  • Upload date:
  • Size: 47.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/7.0.0 CPython/3.14.6

File hashes

Hashes for nsevt-1.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 01bb3fc7733a363fde27f7027dbeb4914e2ae63041de4cf95f64cbee2059e084
MD5 6812ab2c01294daef80f06ad17165a2f
BLAKE2b-256 4a12f242abb0da3451d5a291f8cac979a5194ad59d0b1739137bd86d95ad5533

See more details on using hashes here.

Release history Release notifications | RSS feed

1.0.3

2 files

This release

1.0.2 This release

2 files

1.0.1

2 files

1.0.0

2 files

0.4.1

2 files

0.4.0

2 files

0.3.6

2 files

0.3.5

2 files

0.3.4

2 files

0.3.3

2 files

0.3.2

2 files

0.3.1

2 files

0.3.0

2 files

0.2.0

2 files

0.1.0

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page