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

Download files

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

Source Distribution

escape_fel-0.2.3.tar.gz (12.8 MB view details)

Uploaded Aug 26, 2026 Source

Built Distribution

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

The dropdown lists show the available interpreters, ABIs, and platforms. Enable javascript to be able to filter the list of wheel files.

escape_fel-0.2.3-py3-none-any.whl (3.6 MB view details)

Uploaded Aug 26, 2026 Python 3

File details

Details for the file escape_fel-0.2.3.tar.gz.

File metadata

Download URL: escape_fel-0.2.3.tar.gz
Upload date: Aug 26, 2026
Size: 12.8 MB
Tags: Source
Uploaded using Trusted Publishing? Yes
Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for escape_fel-0.2.3.tar.gz
Algorithm	Hash digest
SHA256	`b366223369a37d9e8c44a555cacb33dd700526168bd8e86f87e00c07cf5bb9de`
MD5	`89732de463c613de2e2dcb637273182e`
BLAKE2b-256	`84447f8b4da480d376bcaf64bb809730d2387f47802f98c715672997e02f7efa`

See more details on using hashes here.

Provenance

The following attestation bundles were made for escape_fel-0.2.3.tar.gz:

Publisher: publish.yml on htlemke/escape-fel

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Statement:
- Statement type: https://in-toto.io/Statement/v1
- Predicate type: https://docs.pypi.org/attestations/publish/v1
- Subject name: escape_fel-0.2.3.tar.gz
- Subject digest: b366223369a37d9e8c44a555cacb33dd700526168bd8e86f87e00c07cf5bb9de
- Sigstore transparency entry: 2601908952
- Sigstore integration time: Aug 26, 2026
Source repository:
- Permalink: htlemke/escape-fel@c8306a81cfb48c10321e4fb0dead1fc9eab2bee1
- Branch / Tag: refs/tags/v0.2.3
- Owner: https://github.com/htlemke
- Access: public
Publication detail:
- Token Issuer: https://token.actions.githubusercontent.com
- Runner Environment: github-hosted
- Publication workflow: publish.yml@c8306a81cfb48c10321e4fb0dead1fc9eab2bee1
- Trigger Event: push