1.4.0
Quickstart
Installation
Using With Docker
5 Minutes to PyhDToolkit
Cpymadtools
Plotting
Utilities
Additional Helpers
Gallery
AC Dipole Driven Tracking Spectrum
Accelerator Aperture
Accelerator Lattice
Beam Enveloppe
Distributions Fitting
Free Tracking Spectrum
LHC Crossing Schemes
LHC IR Errors Assignments
LHC Rigid Waist Shift
Showcasing the Waist Shift
Determining the Waist Shift
Seeing the effect through values of the knob
Machine Survey
Phase Space
Quick LHC Setup
Preparing the LHC setups
As a context manager
Segment-by-Segment Results
Tune Diagram
API Reference
Cpymadtools
Useful Constants
Betatron Coupling Utilities
LHC-Specific Utilities
Matching Routines
Parameters
PTC Routines
Tracking Routines
Tune Utilities
TWISS Routines
Miscellaneous Utilities
Maths
Nonconvex Phase Synchronization
Stats Fitting
Utilities
Models
Particle Beam Models
HTCondor Models
MAD-X Models
Optics
Beam Optics
Ripken Parameters
Twiss Optics
Plotting
Plotting Styles
Paper Styles
Thesis Styles
Aperture Plotters
Crossing Scheme Plotters
Beam Enveloppe Plotters
Lattice Plotters
Layout Plotters
Phase Space Plotters
Tune Diagram Plotters
Segment-by-Segment Coupling
Segment-by-Segment Phase
Plotting Utility Functions
Utils
Command Line Utilities
Context Utilities
Executors Utilities
HTCondor Monitoring
Logging Utilities
Miscellanous Personnal Utilities
Operations Utilities
Printing Utilities
Contributing
Asking for Help
Bug Reports
Enhancement Proposals
Contributing Code and/or Documentation
Forking the Repository
Creating a Development Environment
Creating a Branch
Running the Test Suite
Code Standards
Documentation
Release Notes
Version 1.4.0
1.4.0
Version 1.3.2
1.3.2
Version 1.3.1
1.3.1
Version 1.3.0
1.3.0
Version 1.2.0
1.2.0
Version 1.1.1
1.1.1
Version 1.1.0
1.1.0
Version 1.0.0
1.0.0
Version 0.21.0
0.21.0
Version 0.20.1
0.20.1
Version 0.20.0
0.20.0
Version 0.19.1
0.19.1
Version 0.19.0
0.19.0
Version 0.18.0
0.18.0
Version 0.17.0
0.17.0
Version 0.16.1
0.16.1
Version 0.16.0
0.16.0
Version 0.15.1
0.15.1
Version 0.15.0
0.15.0
Version 0.14.1
0.14.1
Version 0.14.0
0.14.0
Version 0.13.3
0.13.3
Version 0.13.2
0.13.2
Version 0.13.1
0.13.1
Version 0.13.0
0.13.0
Version 0.12.0
0.12.0
Version 0.11.0
0.11.0
Version 0.10.0
0.10.0
Version 0.9.2
0.9.2
Version 0.9.1
0.9.1
Version 0.9.0
0.9.0
Version 0.8.5
0.8.5
Version 0.8.4
0.8.4
Version 0.8.3
0.8.3
Version 0.8.2
0.8.2
Version 0.8.1
0.8.1
Version 0.8.0
0.8.0
Version 0.7.0
0.7.0
Version 0.6.0
0.6.0
Version 0.5.0
0.5.0
Version 0.4.1
0.4.1
Version 0.4.0
0.4.0
Version 0.3.0
0.3.0
Version 0.2.1
0.2.1
Version 0.2.0
0.2.0
Reference bibliography
PyhDToolkit
Index
Edit on GitHub
Index
_
|
A
|
B
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
K
|
L
|
M
|
N
|
P
|
Q
|
R
|
S
|
T
|
U
|
V
|
Z
_
__init__() (pyhdtoolkit.maths.nonconvex_phase_sync.PhaseReconstructor method)
(pyhdtoolkit.optics.beam.Beam method)
A
add_markers_around_lhc_ip() (in module pyhdtoolkit.cpymadtools.lhc._elements)
add_noise_to_arc_bpms() (in module pyhdtoolkit.utils._misc)
add_noise_to_ir_bpms() (in module pyhdtoolkit.utils._misc)
all_unique() (pyhdtoolkit.utils.operations.ListOperations static method)
alpha (pyhdtoolkit.maths.nonconvex_phase_sync.PhaseReconstructor property)
apply_colin_corrs_balance() (in module pyhdtoolkit.utils._misc)
apply_lhc_colinearity_knob() (in module pyhdtoolkit.cpymadtools.lhc._powering)
apply_lhc_colinearity_knob_delta() (in module pyhdtoolkit.cpymadtools.lhc._powering)
apply_lhc_coupling_knob() (in module pyhdtoolkit.cpymadtools.lhc._powering)
apply_lhc_rigidity_waist_shift_knob() (in module pyhdtoolkit.cpymadtools.lhc._powering)
average_by() (pyhdtoolkit.utils.operations.ListOperations static method)
B
B_rho_Tm (pyhdtoolkit.models.beam.BeamParameters property)
Background (class in pyhdtoolkit.utils.printutil)
BaseSummary (class in pyhdtoolkit.models.htc)
Beam (class in pyhdtoolkit.optics.beam)
BeamParameters (class in pyhdtoolkit.models.beam)
best_fit_distribution() (in module pyhdtoolkit.maths.stats_fitting)
beta_r (pyhdtoolkit.models.beam.BeamParameters property)
beta_rel (pyhdtoolkit.optics.beam.Beam property)
bifurcate() (pyhdtoolkit.utils.operations.ListOperations static method)
bifurcate_by() (pyhdtoolkit.utils.operations.ListOperations static method)
brho (pyhdtoolkit.optics.beam.Beam property)
C
c_matrix (pyhdtoolkit.maths.nonconvex_phase_sync.PhaseReconstructor attribute)
c_matrix_eigenvalues (pyhdtoolkit.maths.nonconvex_phase_sync.PhaseReconstructor attribute)
c_matrix_eigenvectors (pyhdtoolkit.maths.nonconvex_phase_sync.PhaseReconstructor attribute)
camel_case() (pyhdtoolkit.utils.operations.StringOperations static method)
capitalize() (pyhdtoolkit.utils.operations.StringOperations static method)
carry_colinearity_knob_over() (in module pyhdtoolkit.cpymadtools.lhc._powering)
check_pid_exists() (pyhdtoolkit.utils.cmdline.CommandLine static method)
chunk_list() (pyhdtoolkit.utils.operations.ListOperations static method)
clamp_number() (pyhdtoolkit.utils.operations.NumberOperations static method)
ClusterSummary (class in pyhdtoolkit.models.htc)
CommandLine (class in pyhdtoolkit.utils.cmdline)
compute_beam_parameters() (in module pyhdtoolkit.optics.beam)
config_logger() (in module pyhdtoolkit.utils.logging)
convert_complex_result_to_phase_values() (pyhdtoolkit.maths.nonconvex_phase_sync.PhaseReconstructor static method)
correct_lhc_global_coupling() (in module pyhdtoolkit.cpymadtools.lhc._coupling)
(in module pyhdtoolkit.cpymadtools.lhc._routines)
correct_lhc_orbit() (in module pyhdtoolkit.cpymadtools.lhc._routines)
courant_snyder_transform() (in module pyhdtoolkit.optics.twiss)
D
deactivate_lhc_arc_sextupoles() (in module pyhdtoolkit.cpymadtools.lhc._powering)
deep_flatten() (pyhdtoolkit.utils.operations.ListOperations static method)
degrees_to_radians() (pyhdtoolkit.utils.operations.NumberOperations static method)
do_kmodulation() (in module pyhdtoolkit.cpymadtools.lhc._routines)
draw_confidence_ellipse() (in module pyhdtoolkit.plotting.utils)
draw_ip_locations() (in module pyhdtoolkit.plotting.utils)
E
E_kin_GeV (pyhdtoolkit.models.beam.BeamParameters property)
E_tot_GeV (pyhdtoolkit.models.beam.BeamParameters property)
eg_x_m (pyhdtoolkit.models.beam.BeamParameters property)
eg_y_m (pyhdtoolkit.models.beam.BeamParameters property)
eta() (pyhdtoolkit.optics.beam.Beam method)
eval_none() (pyhdtoolkit.utils.operations.ListOperations static method)
eval_some() (pyhdtoolkit.utils.operations.ListOperations static method)
execute_function() (pyhdtoolkit.utils.executors.MultiProcessor static method)
(pyhdtoolkit.utils.executors.MultiThreader static method)
export_madx_table() (in module pyhdtoolkit.cpymadtools.utils)
F
farey_sequence() (in module pyhdtoolkit.plotting.tune)
find_ip_s_from_segment_start() (in module pyhdtoolkit.plotting.utils)
Foreground (class in pyhdtoolkit.utils.printutil)
G
gamma_r (pyhdtoolkit.models.beam.BeamParameters property)
gamma_rel (pyhdtoolkit.optics.beam.Beam property)
gamma_transition() (pyhdtoolkit.optics.beam.Beam static method)
get_amplitude_detuning() (in module pyhdtoolkit.cpymadtools.ptc)
get_betastar_from_opticsfile() (in module pyhdtoolkit.utils._misc)
get_closest_tune_approach() (in module pyhdtoolkit.cpymadtools.coupling)
get_cminus_from_coupling_rdts() (in module pyhdtoolkit.cpymadtools.coupling)
get_coupling_rdts() (in module pyhdtoolkit.cpymadtools.coupling)
get_current_orbit_setup() (in module pyhdtoolkit.cpymadtools.lhc._queries)
get_eigenvector_estimator() (pyhdtoolkit.maths.nonconvex_phase_sync.PhaseReconstructor method)
get_footprint_lines() (in module pyhdtoolkit.cpymadtools.tune)
get_footprint_patches() (in module pyhdtoolkit.cpymadtools.tune)
get_indices() (pyhdtoolkit.utils.operations.ListOperations static method)
get_ips_twiss() (in module pyhdtoolkit.cpymadtools.lhc._twiss)
get_ir_twiss() (in module pyhdtoolkit.cpymadtools.lhc._twiss)
get_lhc_bpms_list() (in module pyhdtoolkit.cpymadtools.lhc._misc)
get_lhc_bpms_twiss_and_rdts() (in module pyhdtoolkit.cpymadtools.lhc._coupling)
get_lhc_ips_positions() (in module pyhdtoolkit.plotting.utils)
get_lhc_tune_and_chroma_knobs() (in module pyhdtoolkit.cpymadtools.lhc._misc)
get_magnets_powering() (in module pyhdtoolkit.cpymadtools.lhc._queries)
get_magnitude() (in module pyhdtoolkit.maths.utils)
get_pattern_twiss() (in module pyhdtoolkit.cpymadtools.twiss)
get_rdts() (in module pyhdtoolkit.cpymadtools.ptc)
get_scaled_values_and_magnitude_string() (in module pyhdtoolkit.maths.utils)
get_sizes_at_ip() (in module pyhdtoolkit.cpymadtools.lhc._misc)
get_table_tfs() (in module pyhdtoolkit.cpymadtools.utils)
get_twiss_tfs() (in module pyhdtoolkit.cpymadtools.twiss)
greatest_common_divisor() (pyhdtoolkit.utils.operations.NumberOperations static method)
group_by() (pyhdtoolkit.utils.operations.ListOperations static method)
H
has_duplicates() (pyhdtoolkit.utils.operations.ListOperations static method)
HTCTaskSummary (class in pyhdtoolkit.models.htc)
I
install_ac_dipole_as_kicker() (in module pyhdtoolkit.cpymadtools.lhc._elements)
install_ac_dipole_as_matrix() (in module pyhdtoolkit.cpymadtools.lhc._elements)
install_mpl_styles() (in module pyhdtoolkit.plotting.styles)
is_anagram() (pyhdtoolkit.utils.operations.StringOperations static method)
is_divisible_by() (pyhdtoolkit.utils.operations.NumberOperations static method)
is_palindrome() (pyhdtoolkit.utils.operations.StringOperations static method)
K
kebab_case() (pyhdtoolkit.utils.operations.StringOperations static method)
L
leading_eigenvector (pyhdtoolkit.maths.nonconvex_phase_sync.PhaseReconstructor property)
least_common_multiple() (pyhdtoolkit.utils.operations.NumberOperations static method)
lebedev_beam_size() (in module pyhdtoolkit.optics.ripken)
lhc_orbit_variables() (in module pyhdtoolkit.cpymadtools.lhc._setup)
LHCSetup (class in pyhdtoolkit.cpymadtools.lhc._setup)
ListOperations (class in pyhdtoolkit.utils.operations)
log_runtime_versions() (in module pyhdtoolkit.utils._misc)
longest_item() (pyhdtoolkit.utils.operations.MiscellaneousOperations static method)
M
MADXBeam (class in pyhdtoolkit.models.madx)
make_elements_groups() (in module pyhdtoolkit.plotting.utils)
make_footprint_table() (in module pyhdtoolkit.cpymadtools.tune)
make_lhc_beams() (in module pyhdtoolkit.cpymadtools.lhc._setup)
make_lhc_thin() (in module pyhdtoolkit.cpymadtools.lhc._setup)
make_pdf() (in module pyhdtoolkit.maths.stats_fitting)
make_sixtrack_output() (in module pyhdtoolkit.cpymadtools.lhc._misc)
make_survey_groups() (in module pyhdtoolkit.plotting.utils)
map_values() (pyhdtoolkit.utils.operations.MiscellaneousOperations static method)
match_chromaticities() (in module pyhdtoolkit.cpymadtools.matching)
match_no_coupling_through_ripkens() (in module pyhdtoolkit.cpymadtools.coupling)
match_tunes() (in module pyhdtoolkit.cpymadtools.matching)
match_tunes_and_chromaticities() (in module pyhdtoolkit.cpymadtools.matching)
maybe_get_ax() (in module pyhdtoolkit.plotting.utils)
misalign_lhc_ir_quadrupoles() (in module pyhdtoolkit.cpymadtools.lhc._errors)
misalign_lhc_triplets() (in module pyhdtoolkit.cpymadtools.lhc._errors)
MiscellaneousOperations (class in pyhdtoolkit.utils.operations)
module
pyhdtoolkit.cpymadtools.constants
pyhdtoolkit.cpymadtools.coupling
pyhdtoolkit.cpymadtools.lhc
pyhdtoolkit.cpymadtools.lhc._coupling
pyhdtoolkit.cpymadtools.lhc._elements
pyhdtoolkit.cpymadtools.lhc._errors
pyhdtoolkit.cpymadtools.lhc._misc
pyhdtoolkit.cpymadtools.lhc._powering
pyhdtoolkit.cpymadtools.lhc._queries
pyhdtoolkit.cpymadtools.lhc._routines
pyhdtoolkit.cpymadtools.lhc._setup
pyhdtoolkit.cpymadtools.lhc._twiss
pyhdtoolkit.cpymadtools.matching
pyhdtoolkit.cpymadtools.parameters
pyhdtoolkit.cpymadtools.ptc
pyhdtoolkit.cpymadtools.track
pyhdtoolkit.cpymadtools.tune
pyhdtoolkit.cpymadtools.twiss
pyhdtoolkit.cpymadtools.utils
pyhdtoolkit.maths.nonconvex_phase_sync
pyhdtoolkit.maths.stats_fitting
pyhdtoolkit.maths.utils
pyhdtoolkit.models.beam
pyhdtoolkit.models.htc
pyhdtoolkit.models.madx
pyhdtoolkit.optics.beam
pyhdtoolkit.optics.ripken
pyhdtoolkit.optics.twiss
pyhdtoolkit.plotting.aperture
pyhdtoolkit.plotting.crossing
pyhdtoolkit.plotting.envelope
pyhdtoolkit.plotting.lattice
pyhdtoolkit.plotting.layout
pyhdtoolkit.plotting.phasespace
pyhdtoolkit.plotting.sbs.coupling
pyhdtoolkit.plotting.sbs.phase
pyhdtoolkit.plotting.styles
pyhdtoolkit.plotting.styles.paper
pyhdtoolkit.plotting.styles.thesis
pyhdtoolkit.plotting.tune
pyhdtoolkit.plotting.utils
pyhdtoolkit.utils._misc
pyhdtoolkit.utils.cmdline
pyhdtoolkit.utils.contexts
pyhdtoolkit.utils.executors
pyhdtoolkit.utils.htc_monitor
pyhdtoolkit.utils.logging
pyhdtoolkit.utils.operations
pyhdtoolkit.utils.printutil
MultiProcessor (class in pyhdtoolkit.utils.executors)
MultiThreader (class in pyhdtoolkit.utils.executors)
N
normalized_emittance (pyhdtoolkit.optics.beam.Beam property)
NumberOperations (class in pyhdtoolkit.utils.operations)
P
ParticleEnum (class in pyhdtoolkit.models.madx)
PhaseReconstructor (class in pyhdtoolkit.maths.nonconvex_phase_sync)
plot_aperture() (in module pyhdtoolkit.plotting.aperture)
plot_beam_envelope() (in module pyhdtoolkit.plotting.envelope)
plot_courant_snyder_phase_space() (in module pyhdtoolkit.plotting.phasespace)
plot_courant_snyder_phase_space_colored() (in module pyhdtoolkit.plotting.phasespace)
plot_full_ip_rdt() (in module pyhdtoolkit.plotting.sbs.coupling)
plot_latwiss() (in module pyhdtoolkit.plotting.lattice)
plot_machine_layout() (in module pyhdtoolkit.plotting.layout)
plot_machine_survey() (in module pyhdtoolkit.plotting.lattice)
plot_phase_segment() (in module pyhdtoolkit.plotting.sbs.phase)
plot_phase_segment_both_beams() (in module pyhdtoolkit.plotting.sbs.phase)
plot_phase_segment_one_beam() (in module pyhdtoolkit.plotting.sbs.phase)
plot_physical_apertures() (in module pyhdtoolkit.plotting.aperture)
plot_rdt_component() (in module pyhdtoolkit.plotting.sbs.coupling)
plot_resonance_lines_for_order() (in module pyhdtoolkit.plotting.tune)
plot_single_ir_crossing() (in module pyhdtoolkit.plotting.crossing)
plot_tune_diagram() (in module pyhdtoolkit.plotting.tune)
plot_two_lhc_ips_crossings() (in module pyhdtoolkit.plotting.crossing)
power_landau_octupoles() (in module pyhdtoolkit.cpymadtools.lhc._powering)
prepare_lhc_run2() (in module pyhdtoolkit.cpymadtools.lhc._setup)
prepare_lhc_run3() (in module pyhdtoolkit.cpymadtools.lhc._setup)
ptc_track_particle() (in module pyhdtoolkit.cpymadtools.ptc)
ptc_twiss() (in module pyhdtoolkit.cpymadtools.ptc)
pyhdtoolkit.cpymadtools.constants
module
pyhdtoolkit.cpymadtools.coupling
module
pyhdtoolkit.cpymadtools.lhc
module
pyhdtoolkit.cpymadtools.lhc._coupling
module
pyhdtoolkit.cpymadtools.lhc._elements
module
pyhdtoolkit.cpymadtools.lhc._errors
module
pyhdtoolkit.cpymadtools.lhc._misc
module
pyhdtoolkit.cpymadtools.lhc._powering
module
pyhdtoolkit.cpymadtools.lhc._queries
module
pyhdtoolkit.cpymadtools.lhc._routines
module
pyhdtoolkit.cpymadtools.lhc._setup
module
pyhdtoolkit.cpymadtools.lhc._twiss
module
pyhdtoolkit.cpymadtools.matching
module
pyhdtoolkit.cpymadtools.parameters
module
pyhdtoolkit.cpymadtools.ptc
module
pyhdtoolkit.cpymadtools.track
module
pyhdtoolkit.cpymadtools.tune
module
pyhdtoolkit.cpymadtools.twiss
module
pyhdtoolkit.cpymadtools.utils
module
pyhdtoolkit.maths.nonconvex_phase_sync
module
pyhdtoolkit.maths.stats_fitting
module
pyhdtoolkit.maths.utils
module
pyhdtoolkit.models.beam
module
pyhdtoolkit.models.htc
module
pyhdtoolkit.models.madx
module
pyhdtoolkit.optics.beam
module
pyhdtoolkit.optics.ripken
module
pyhdtoolkit.optics.twiss
module
pyhdtoolkit.plotting.aperture
module
pyhdtoolkit.plotting.crossing
module
pyhdtoolkit.plotting.envelope
module
pyhdtoolkit.plotting.lattice
module
pyhdtoolkit.plotting.layout
module
pyhdtoolkit.plotting.phasespace
module
pyhdtoolkit.plotting.sbs.coupling
module
pyhdtoolkit.plotting.sbs.phase
module
pyhdtoolkit.plotting.styles
module
pyhdtoolkit.plotting.styles.paper
module
pyhdtoolkit.plotting.styles.thesis
module
pyhdtoolkit.plotting.tune
module
pyhdtoolkit.plotting.utils
module
pyhdtoolkit.utils._misc
module
pyhdtoolkit.utils.cmdline
module
pyhdtoolkit.utils.contexts
module
pyhdtoolkit.utils.executors
module
pyhdtoolkit.utils.htc_monitor
module
pyhdtoolkit.utils.logging
module
pyhdtoolkit.utils.operations
module
pyhdtoolkit.utils.printutil
module
Q
query_arc_correctors_powering() (in module pyhdtoolkit.cpymadtools.lhc._queries)
query_beam_attributes() (in module pyhdtoolkit.cpymadtools.parameters)
query_condor_q() (in module pyhdtoolkit.utils.htc_monitor)
query_triplet_correctors_powering() (in module pyhdtoolkit.cpymadtools.lhc._queries)
R
radians_to_degrees() (pyhdtoolkit.utils.operations.NumberOperations static method)
re_cycle_sequence() (in module pyhdtoolkit.cpymadtools.lhc._setup)
read_condor_q() (in module pyhdtoolkit.utils.htc_monitor)
reconstruct_complex_phases_evm() (pyhdtoolkit.maths.nonconvex_phase_sync.PhaseReconstructor method)
reconstructor_matrix (pyhdtoolkit.maths.nonconvex_phase_sync.PhaseReconstructor property)
reset_lhc_bump_flags() (in module pyhdtoolkit.cpymadtools.lhc._misc)
revolution_frequency() (pyhdtoolkit.optics.beam.Beam method)
rms_emittance (pyhdtoolkit.optics.beam.Beam property)
run() (pyhdtoolkit.utils.cmdline.CommandLine static method)
S
sample() (pyhdtoolkit.utils.operations.ListOperations static method)
sanitize_list() (pyhdtoolkit.utils.operations.ListOperations static method)
scale_patches() (in module pyhdtoolkit.plotting.layout)
set_arrow_label() (in module pyhdtoolkit.plotting.utils)
set_distributions_dict() (in module pyhdtoolkit.maths.stats_fitting)
setup_lhc_orbit() (in module pyhdtoolkit.cpymadtools.lhc._setup)
shuffle() (pyhdtoolkit.utils.operations.ListOperations static method)
snake_case() (pyhdtoolkit.utils.operations.StringOperations static method)
space_dimension (pyhdtoolkit.maths.nonconvex_phase_sync.PhaseReconstructor attribute)
split_complex_columns() (in module pyhdtoolkit.utils._misc)
spread() (pyhdtoolkit.utils.operations.ListOperations static method)
StringOperations (class in pyhdtoolkit.utils.operations)
Styles (class in pyhdtoolkit.utils.printutil)
switch_magnetic_errors() (in module pyhdtoolkit.cpymadtools.lhc._powering)
symmetric_difference_by() (pyhdtoolkit.utils.operations.ListOperations static method)
T
terminate() (pyhdtoolkit.utils.cmdline.CommandLine static method)
timeit() (in module pyhdtoolkit.utils.contexts)
track_single_particle() (in module pyhdtoolkit.cpymadtools.track)
U
union_by() (pyhdtoolkit.utils.operations.ListOperations static method)
V
vary_independent_ir_quadrupoles() (in module pyhdtoolkit.cpymadtools.lhc._powering)
Z
zipper() (pyhdtoolkit.utils.operations.ListOperations static method)