It is recommended to perform the installation inside a virtual environment.
Install this module with pip
pip install -U git+https://github.com/mtitze/touscheklib.gitfrom touscheklib import optics_tools
lattice_filename = 'name_of_your_MAD-X_lattice' # don't forget an RF cavity.
# Set some beam input parameters. Note that EX and EY may be changed later, when the natural parameters
# are computed:
beam = {'PARTICLE': 'ELECTRON', 'ENERGY': 1.7, 'EX': 7.54543712e-09, 'EY': 1.2e-10, 'NPART': 5000000000.0, 'SIGE': 0.00069541, 'SIGT': 0.0029196, 'radiate': True}
# Create optics class with given lattice and beam parameters:
opt = optics_tools.optics(lattice_filename, beam_params=beam, show_init=False, verbose=True)
# Compute Touschek-lifetime, here assuming a machine symmetry of 8 which will increase the calculation speed.
# We also use the fast routine (precise == False). The optional coupling parameter coupling_y can be used to enlarge EY by coupling_y*EX:
touschek_results = opt.touschek_lifetime(precise=False, symmetry=8, coupling_y=0.02)
# Plot the results
opt.plot_touschek_losses(touschek_results=touschek_results)touscheklib can also be run as script from the command line:
python -m touscheklib <lattice_filename> <json_beam_filename> [optional arguments]
Show command line syntax:
python -m touscheklib -h
https://touscheklib.readthedocs.io/en/latest/index.html
This file is part of touscheklib.
touscheklib is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
touscheklib is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with touscheklib. If not, see https://www.gnu.org/licenses/.