Data

Tools

Indexes

Applications

Experiments

Open Source Science

ParticlePhaseSpace

ParticlePhaseSpace: A python package for streamlined import, analysis, and export of particle phase space data - Published in JOSS (2023)

https://github.com/bwheelz36/particlephasespace

Science Score: 95.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ○
    CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ✓
    DOI references
    Found 1 DOI reference(s) in JOSS metadata
  • ○
    Academic publication links
  • ✓
    Committers with academic emails
    1 of 4 committers (25.0%) from academic institutions
  • ○
    Institutional organization owner
  • ✓
    JOSS paper metadata
    Published in Journal of Open Source Software

Keywords

accelerator-physics particles phase-space topas topas-mc twiss

Scientific Fields

Materials Science Physical Sciences - 40% confidence
Last synced: 4 months ago · JSON representation

Repository

Import, analysis, and export of particle phase space data

Basic Info
Statistics
  • Stars: 13
  • Watchers: 1
  • Forks: 8
  • Open Issues: 8
  • Releases: 16
Topics
accelerator-physics particles phase-space topas topas-mc twiss
Created about 3 years ago · Last pushed 12 months ago
Metadata Files
Readme License

README.md

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. The easiest way to install these is using poetry and running poetry install --with dev

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:

Owner

  • Login: bwheelz36
  • Kind: user

JOSS Publication

ParticlePhaseSpace: A python package for streamlined import, analysis, and export of particle phase space data
Published
September 11, 2023
DOI
Volume 8, Issue 89, Page 5375
Authors
Brendan Whelan ORCID
Image-X Institute, School of Health Sciences, University of Sydney
Leo Esnault ORCID
Univ. Bordeaux-CNRS-CEA, Centre Lasers Intenses et Applications, UMR 5107, 33405 Talence, France
Editor
Matthew Feickert ORCID
Tags
Python accelerator physics topas-mc phase space
View PDF Review Thread Software Archive

GitHub Events

Total
  • Watch event: 1
  • Delete event: 1
  • Issue comment event: 1
  • Push event: 1
  • Pull request event: 2
  • Create event: 1
Last Year
  • Watch event: 1
  • Delete event: 1
  • Issue comment event: 1
  • Push event: 1
  • Pull request event: 2
  • Create event: 1

Committers

Last synced: 5 months ago

All Time
  • Total Commits: 214
  • Total Committers: 4
  • Avg Commits per committer: 53.5
  • Development Distribution Score (DDS): 0.393
Past Year
  • Commits: 1
  • Committers: 1
  • Avg Commits per committer: 1.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
Brendan b****0@g****m 130
brendan b****n@s****u 76
icmeyer i****0@g****m 5
Axel Huebl a****l@p****a 3
Committer Domains (Top 20 + Academic)
plasma.ninja: 1 sydney.edu.au: 1

Issues and Pull Requests

Last synced: 4 months ago

All Time
  • Total issues: 76
  • Total pull requests: 63
  • Average time to close issues: about 1 month
  • Average time to close pull requests: about 8 hours
  • Total issue authors: 8
  • Total pull request authors: 6
  • Average comments per issue: 1.14
  • Average comments per pull request: 0.46
  • Merged pull requests: 61
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 2
  • Pull requests: 1
  • Average time to close issues: N/A
  • Average time to close pull requests: less than a minute
  • Issue authors: 1
  • Pull request authors: 1
  • Average comments per issue: 0.0
  • Average comments per pull request: 0.0
  • Merged pull requests: 1
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • bwheelz36 (59)
  • benjaminbolling (5)
  • ax3l (3)
  • brendan-whelan-seetreat (2)
  • lars-mejnertsen-seetreat (2)
  • MarcBHahn (1)
  • louiemurcia (1)
  • cvelten (1)
Pull Request Authors
  • bwheelz36 (60)
  • ax3l (4)
  • MarcBHahn (2)
  • icmeyer (2)
  • benjaminbolling (1)
  • matthewfeickert (1)
Top Labels
Issue Labels
enhancement (12) documentation (1)
Pull Request Labels
enhancement (2)

Dependencies

.github/workflows/build_docs.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v3 composite
  • peaceiris/actions-gh-pages v3 composite
.github/workflows/python-publish.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v3 composite
  • pypa/gh-action-pypi-publish 27b31702a0e7fc50959f5ad993c78deac1bdfc29 composite
.github/workflows/run_tests.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v3 composite
  • codecov/codecov-action v3 composite
pyproject.toml pypi