straxion 0.3.1

strax-based time series analysis for single photon counting experiments

straxion

strax-based time series analysis for single photon counting experiments. straxion is currently used by (new) QAULIPHIDE dark photon search experiments.

Installation

Ideally, straxion works with Python 3.11 or 3.12. Python 3.13 is not recommended due to lack of support from strax (by strax 2.1.1).

cd straxion
pip install -e ./

Tutorials

• See this document for strax related functionality.
• Check notebooks/ for straxion tutorials in the QUALIPHIDE context.

Tests

The test pipeline in tests/ is built based on synthesized data contained in the released tag test-data. Please refer to docs/SECURE_TEST_DATA_SETUP.md for how to update or add test data. The tests are triggered every time a commit is made in a pull request, and one can refer to Actions of this repo for examples.

Contribution

• This is a public repo. Please avoid putting sensitive information about the experiments in either plots or code.
• Please make a pull request for any development, except for documentation-related edits.
• Note that pre-commit will automatically examine and try to fix the code styles for each commit. Sometimes the fix cannot be done automatically, and you will need to update manually at your discretion.
• Please avoid bumping versions of this package or the plugins without communication with other developers.