/twissed

Python package for beam dynamic analysis well-suited for laser-wakefield acceleration

Primary LanguagePythonMIT LicenseMIT

Twissed

pypi version License Release

Overview

Twissed is a Python package 🐍 that provides a large number of data analysis tools for beam dynamics and laser wakefield acceleration simulations.

Twissed is also a robust API between beam dynamics and laser-plasma simulation codes.

Twissed is multi-OS (Windows, Linux, Mac) and can be easily installed everywhere thanks to its low number of dependencies (numpy, pandas, scipy, h5py). It is especially made to run on HPC clusters (graphic packages, such as matplotlib are optional).

Documentation and tutorials

The documentation is here: https://twissed.github.io

Tutorials are available here: https://github.com/Twissed/twissed_tutorial

Source code are here: https://github.com/Twissed/twissed

API

Twissed can read and write data from several sources

Installation

Requirement

Python 3.7 or greater

  • Mandatory packages: numpy pandas scipy h5py.
  • Optional packages: matplotlib seaborn happi(smilei)

Installation

  • Mac OS/Linux
python -m pip install twissed
  • Windows
py -m pip install twissed

It is also possible to download the source code for installation

  • Mac OS/Linux
git clone https://github.com/Twissed/twissed.git
python -m pip install -e .
  • Windows
git clone https://github.com/Twissed/twissed.git
py -m pip install -e .