Welcome to twissed’s documentation!

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

• Mac OS/Linux

python -m pip install twissed

• Windows

py -m pip install twissed

With the download of the project

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

Tutorial

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

Note

This project is under active development.

Indices and tables

• Index

• Module Index

• Search Page

Contents

Contents:

• Tutorial for beam analysis
• Useful formulas
  • Statistics
  • Physics
  • Helpful
• Step class
  • Metadata
  • Introduction ot Step
  • Functions
  • Beam functions
• Plotting with the Step class
  • hist1D and hist2D functions
• Read and write data
  • read_dst()
• Automatic launchers and runs
  • Run class
  • Classic launcher
  • Genetic Algorithm launcher
• No weight methods
  • Zero order methods
• Todo