Table of contents
User’s Guide
- User’s guide
- Installation
- Getting started
- Line and environment
- Creating a simple Line object
- Line inspection,
Line.get_table()
,Line.attr[...]
- References and deferred expressions
- Lattice construction capabilities
- Importing a line from MAD-X
- Save and reload lines
- Element insertion
- Element slicing
- Simulation of small rings: drifts, bends, fringe fields
- Extraction of second order transfer maps
- Apply transformations (tilt, shift) to elements
- Add multipolar components to elements
- Cut line elements at given s positions
- Twiss
- Match
- Basic usage
- Match at specific locations
- Boundary conditions and target values from existing table
- Match involving multiple lines
- Callables and inequalities in targets
- Matching on results of arbitrary actions
- Interactive match
- Create new knobs by matching
- Targets from variables and from line elements
- Match and twiss with symmetry constraints on one boundary
- Track
- Particles
- Introduction
- Building particles with the Particles class
- The
build_particles
function - Generating particles distributions
- Copying a Particles object (optionally across contexts)
- Saving and loading Particles objects to/from dictionary or file
- Merging and filtering Particles objects
- Accessing particles coordinates on GPU contexts
- Closed orbit and trajectory correction
- Collective effects
- Collimation
- Loss location refinement
- Intra-Beam Scattering
- Synchrotron radiation
- Tune footprint and stability diagram
- Data management in Xsuite
- Lost particles state codes
Reference manual
- Reference manual
- xtrack.Environment class
- xtrack.Line class
Line
Line.from_dict()
Line.from_json()
Line.from_sequence()
Line.from_sixinput()
Line.from_madx_sequence()
Line.to_dict()
Line.to_madx_sequence()
Line.to_madng()
Line.to_json()
Line.to_pandas()
Line.copy()
Line.build_tracker()
Line.discard_tracker()
Line.track()
Line.slice_thick_elements()
Line.build_particles()
Line.twiss()
Line.twiss4d()
Line.match()
Line.match_knob()
Line.survey()
Line.correct_trajectory()
Line.find_closed_orbit()
Line.compute_T_matrix()
Line.get_footprint()
Line.get_amplitude_detuning_coefficients()
Line.compute_one_turn_matrix_finite_differences()
Line.get_non_linear_chromaticity()
Line.get_length()
Line.get_s_elements()
Line.get_s_position()
Line.cut_at_s()
Line.insert_element()
Line.append_element()
Line.filter_elements()
Line.cycle()
Line.freeze_energy()
Line.freeze_longitudinal()
Line.freeze_vars()
Line.unfreeze_vars()
Line.configure_bend_model()
Line.configure_radiation()
Line.configure_intrabeam_scattering()
Line.compensate_radiation_energy_loss()
Line.optimize_for_tracking()
Line.start_internal_logging_for_elements_of_type()
Line.stop_internal_logging_for_all_elements()
Line.stop_internal_logging_for_elements_of_type()
Line.remove_markers()
Line.remove_inactive_multipoles()
Line.remove_zero_length_drifts()
Line.merge_consecutive_drifts()
Line.remove_redundant_apertures()
Line.use_simple_quadrupoles()
Line.use_simple_bends()
Line.get_elements_of_type()
Line.check_aperture()
Line.merge_consecutive_multipoles()
Line.get_line_with_second_order_maps()
Line.set()
Line.get()
Line.info()
Line.eval()
Line.new_expr()
Line.get_expr()
Line.name
- Track
- Twiss
- Match
Line.match()
Optimize
Optimize.step()
Optimize.solve()
Optimize.vary_status()
Optimize.target_status()
Optimize.get_knob_values()
Optimize.show()
Optimize.log()
Optimize.reload()
Optimize.clear_log()
Optimize.add_point_to_log()
Optimize.tag()
Optimize.enable()
Optimize.disable()
Optimize.get_merit_function()
Optimize.enable_vary()
Optimize.disable_vary()
Optimize.enable_targets()
Optimize.disable_targets()
Optimize.disable_all_targets()
Optimize.enable_all_targets()
Optimize.disable_all_vary()
Optimize.enable_all_vary()
- Vary and Target
- Trajectory correction
- Build particles
- Particles class
Particles
Particles.from_dict()
Particles.to_dict()
Particles.to_json()
Particles.from_pandas()
Particles.to_pandas()
Particles.to_table()
Particles.get_table()
Particles.merge()
Particles.filter()
Particles.sort()
Particles.reorganize()
Particles.hide_lost_particles()
Particles.unhide_lost_particles()
Particles.remove_unused_space()
Particles.add_particles()
Particles.get_active_particle_id_range()
Particles.show()
Particles.get_classical_particle_radius0()
Particles.hide_first_n_particles()
Particles.unhide_first_n_particles()
Particles.update_delta()
Particles.update_ptau()
Particles.update_p0c()
Particles.update_gamma0()
Particles.update_beta0()
Particles.add_to_energy()
- Generation of particles distributions
- CPU and GPU contexts
- Configuration tools
- Beam elements (xtrack)
- Marker
- Drift
- Bend
- Quadrupole
- CombinedFunctionMagnet
- DipoleEdge
- Sextupole
- Multipole
- Solenoid
- NonLinearLens
- Cavity
- RFMultipole
- ReferenceEnergyIncrease
- Elens
- Exciter
- Wire
- FirstOrderTaylorMap
- SecondOrderTaylorMap
- LineSegmentMap
- LinearTransferMatrix
- LongitudinalLimitRect
- XYShift
- SRotation
- XRotation
- YRotation
- ZetaShift
- LimitEllipse
- LimitRect
- LimitRectEllipse
- LimitRacetrack
- LimitPolygon
- ParticlesMonitor
- LastTurnsMonitor
- Beam elements (xfields)
Physics Guide
Developer’s Guide
- Developer’s guide
- Definition of new Xtrack-compatible beam elements
- Multiplatform programming with xobjects
- Code autogeneration
- Numerical reproducibility
- Continuous testing of xsuite