Twissed

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 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.

Twissed can read and write data from several sources

• FBPIC
• Smilei
• Smilei via happi package
• TraceWin
• Astra

Installation

Requirement

Python 3.7 or greater

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

Installation

After downloading the project:

• Mac OS/Linux

python -m pip install -e .

• Windows

py -m pip install -e .

Tutorial

Examples Twissed use are available at https://github.com/Twissed/Twissed_tutorial MIT License

Copyright (c) 2024 Twissed

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.