https://github.com/christophermayes/openpmd-beamphysics
Tools for analyzing and viewing particle data in the openPMD standard, extension beamphysics.
https://github.com/christophermayes/openpmd-beamphysics
fields openpmd particles phase-space twiss
Last synced: about 1 month ago
JSON representation
Tools for analyzing and viewing particle data in the openPMD standard, extension beamphysics.
- Host: GitHub
- URL: https://github.com/christophermayes/openpmd-beamphysics
- Owner: ChristopherMayes
- License: apache-2.0
- Created: 2019-06-17T17:45:15.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2025-03-26T18:21:05.000Z (about 1 year ago)
- Last Synced: 2025-04-09T15:05:40.177Z (12 months ago)
- Topics: fields, openpmd, particles, phase-space, twiss
- Language: Python
- Homepage: https://christophermayes.github.io/openPMD-beamphysics/
- Size: 306 MB
- Stars: 17
- Watchers: 4
- Forks: 16
- Open Issues: 21
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# openPMD-beamphysics
| **`Documentation`** |
| -------------------------------------------------------------------------------------------------------------------------------------------- |
| [](https://christophermayes.github.io/openPMD-beamphysics/) |
Tools for analyzing and viewing particle data in the openPMD standard, extension beamphysics.
# Installing openpmd-beamphysics
Installing `openpmd-beamphysics` from the `conda-forge` channel can be achieved by adding `conda-forge` to your channels with:
```
conda config --add channels conda-forge
```
Once the `conda-forge` channel has been enabled, `openpmd-beamphysics` can be installed with:
```
conda install openpmd-beamphysics
```
It is possible to list all of the versions of `openpmd-beamphysics` available on your platform with:
```
conda search openpmd-beamphysics --channel conda-forge
```
## Development environment
A conda environment file is provided in this repository and may be used for a
development environment.
To create a new conda environment using this file, do the following:
```bash
git clone https://github.com/ChristopherMayes/openPMD-beamphysics
cd openPMD-beamphysics
conda env create -n beamphysics-dev -f environment.yml
conda activate beamphysics-dev
python -m pip install --no-deps -e .
```
Alternatively, with a virtualenv and pip:
```bash
git clone https://github.com/ChristopherMayes/openPMD-beamphysics
cd openPMD-beamphysics
python -m venv beamphysics-venv
source beamphysics-venv/bin/activate
python -m pip install -e .
```