escape
Event Synchronous Categorisation And Processing Environment
escape is a Python framework for event-based data analysis at free-electron laser (FEL) facilities. It pairs raw measurement arrays with pulse IDs and scan metadata, providing index-aligned arithmetic, scan-step aggregation, and scalable storage — designed for the data volumes and workflows typical at instruments like SwissFEL Bernina.
Core concepts
Array— wraps a data array together with a pulse-ID index and optional scan grouping. Index-aligned arithmetic between arrays is automatic: operations find common pulse IDs and align data before computing.Scan— partitions an Array into sequential steps with parameter metadata (e.g. delay values). Exposes per-step statistics (nanmean,median,weighted_stat, …) directly.Grid— maps scan steps onto an N-dimensional parameter grid, enabling multi-dimensional scans and 2D result arrays.DataSet— named collection of Arrays backed by HDF5 (.esc.h5) or zarr (.esc.zarr) files for persistent storage.escaped— decorator that lifts any NumPy/dask function to operate on Arrays with automatic index alignment.
Quick example
import escape as esc
import numpy as np
# Load a dataset
ds = esc.DataSet.load("run042.esc.h5")
sig = ds["JF_signal"]
i0 = ds["I0_monitor"]
pump = ds["pump_on"]
# Normalize signal to I0 — pulse IDs aligned automatically
sig_norm = sig / i0
# Per-step median across the pump-probe scan
median_on = sig_norm[pump].scan.nanmedian()
median_off = sig_norm[~pump].scan.nanmedian()
Installation
conda (recommended — reuses existing environment packages):
conda install -c conda-forge escape-fel
pip:
pip install escape-fel
Latest development version:
pip install git+https://github.com/htlemke/escape-fel
Documentation
Full documentation including user guide and API reference: escape-fel.readthedocs.io
Links
1 maintainer
Metadata
1 maintainer
Release files for escape-fel 0.2.15
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| escape_fel-0.2.15.tar.gz | 13.7 MB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| escape_fel-0.2.15-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 17.8 MB
Release files / escape_fel-0.2.15.tar.gz
| Download URL | escape_fel-0.2.15.tar.gz |
|---|---|
| Size | 13.7 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
95050050a26b848c99b3c1a6e97efa062f6d267e44d5199bc8a0f5bd13d6ddcd
|
|
BLAKE2b-256 checksum How to use checksums |
c168fd129a69b4f48d2168f44271b98dd75f5864ad9f27601dc47aa07c159542
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 6, 2026.
Transparency logRelease files / escape_fel-0.2.15-py3-none-any.whl
| Download URL | escape_fel-0.2.15-py3-none-any.whl |
|---|---|
| Size | 4.2 MB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
1991de8734ed860bb36cc5be7bfb969f899a5b109ea5f1d25e2c2f18dd03f400
|
|
BLAKE2b-256 checksum How to use checksums |
c56930f1f826e3b2e9adfb41168144331e5beaa75abdf4a5f3d55f07e1112282
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 6, 2026.
Transparency log
