sed-processor is a backend to process and bin multidimensional single-event datastreams, with the intended primary use case in multidimensional photoelectron spectroscopy using time-of-flight instruments.
It builds on Dask dataframes, where each column represents a multidimensional "coordinate" such as position, time-of-flight, pump-probe delay etc., and each entry represents one electron. The SedProcessor class provides a single user entry point, and provides functions for handling various workflows for coordinate transformation, e.g. corrections and calibrations.
Furthermore, "sed-processor" provides fast and parallelized binning routines to compute multidimensional histograms from the processed dataframes in a delayed fashion, thus reducing requirements on cpu power and memory consumption.
Finally, in contains several export routines, including export into the NeXus format with rich and standardized metadata annotation.
Installation
Prerequisites
- Python 3.9+
- pip
Steps
- Create a new virtual environment using either venv, pyenv, conda, etc. See below for an example.
python -m venv .sed-venv
- Activate your environment:
# On macOS/Linux
source .sed-venv/bin/activate
# On Windows
.sed-venv\Scripts\activate
- Install
sed, distributed assed-processoron PyPI:
pip install sed-processor[all]
- If you intend to work with Jupyter notebooks, it is helpful to install a Jupyter kernel for your environment. This can be done, once your environment is activated, by typing:
python -m ipykernel install --user --name=sed_kernel
- If you do not use Jupyter Notebook or Jupyter Lab, you can skip the installing those dependencies
pip install sed-processor
Documentation
Comprehensive documentation including several workflow examples can be found here: https://opencompes.github.io/docs/sed/stable/
Contributing
Users are welcome to contribute to the development of sed-processor. Information how to contribute, including how to install developer versions can be found in the documentation
We would like to thank our contributors!
License
sed-processor is licenced under the MIT license
Copyright (c) 2022-2024 OpenCOMPES
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
3 maintainers
Metadata
3 maintainers
Release files for sed-processor 1.3.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| sed_processor-1.3.1.tar.gz | 146.6 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| sed_processor-1.3.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 314.4 kB
Release files / sed_processor-1.3.1.tar.gz
| Download URL | sed_processor-1.3.1.tar.gz |
|---|---|
| Size | 146.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
0c05d03a469980f9d29fa30b0a72bc27ddc93365c19349d558c593d78f2a97b0
|
|
BLAKE2b-256 checksum How to use checksums |
745848ca768f0b79f1fbb5a93c6e35060522e4948934d907c50810d9e8918a5d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.12
|
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 May 16, 2026.
Transparency logRelease files / sed_processor-1.3.1-py3-none-any.whl
| Download URL | sed_processor-1.3.1-py3-none-any.whl |
|---|---|
| Size | 167.8 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
cd8305773c61fe1feab62a441164626fb1bf1ee6db6a9ca9bb6dfa3f4539804d
|
|
BLAKE2b-256 checksum How to use checksums |
543384dcb6c1f3ad8a0505b1c2fe80e25ef72c375bb957c2e19b4fff60d1161f
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.12
|
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 May 16, 2026.
Transparency log
