Skip to content

bwheelz36/ParticlePhaseSpace

Repository files navigation

ParticlePhaseSpace

testscodecovPyPI versionPyPI - Python Version

Common library for dealing with particle phase spaces, revolving around the simple workflow of import, analyse, export. If you have a data format that we can't already work with, extension mechanisms are provided for writing new DataLoaders and DataExporters.

Install and Requirements

To install: pip install ParticlePhaseSpace

If you want to develop the code, there are some additional requirements, listed in dev_requirements.txt

Usage and Documentation

  • Detailed documentation is provided here.
  • The source code for the worked examples is inside the examples folder.
  • For a list of the current data loaders, see here

Directory Structure

  • ParticlePhaseSpaace: source code
  • examples: source code for the worked examples provided in the docs
  • docsrc: markdown/rst documentation.
  • tests: tests which are run through github actions

Contributions

Contributions in the form of pull requests are very welcome! Please use the 'issues' tab in this repository to report problems or request support

Other packages for analysis of particle phase space data

Below is a (almost certainly incomplete) list of other packages I have come accross for analysis of particle phase space data: