0.16.0
Enhancements
A new module,
pyhdtoolkit.cpymadtools.couplinghas been added, and now hosts functions to get the closest tune approach (get_closest_tune_approach) and match coupling throughRipkenparameters (match_no_coupling_through_ripkens).The
pyhdtoolkit.cpymadtools.lhcmodule has a new function,get_lhc_bpms_list, which returns the list of monitoring BPMs for the current LHC sequence in use.The
pyhdtoolkit.cpymadtools.lhcmodule now hosts theget_lhc_tune_and_chroma_knobsfunction.The
pyhdtoolkit.cpymadtools.plotters.plot_machine_layouthave now been made public api.The
DEFAULT_TWISS_COLUMNSconstant inpyhdtoolkit.cpymadtools.constantsnow includes the element length.A new private
_miscmodule has been added to theutilssub-package.
Bug Fixes
The
plot_apertureandplot_latwissfunctions now properly propagate the xoffset and xlimits parameters toplot_machine_layout, which restores the proper functionality for these parameters and speeds up the plotting significantly when they are used.The
get_closest_tune_approachfunction now does not provide chromaticiy targets in its matching, as it can mess up the algorithm when givenCHROMwhich it does.The
match_tunes_and_chromaticitiesfunction now properly handles the knobs sent depending on the matching targets. For instance, only tune knobs are varied when only tune targets are provided. Explicitely given knobs are always sent.The
get_twiss_tfsfunction now calls theTWISScommand fromMAD-Xand accepts keyword arguments.
Documentation
All docstrings have been reviewed and now include examples. Those mentioning caveats have been given special admonitions to do so.
The documentation has gone through a major overhaul and is now built on
sphinxand its extensions. It now also includes a quickstart tutorial, a gallery of examples, a contributing guide and a reference bibliography. Feedback on the new documentation is very welcome.
Maintenance
The deprecated
pyhdtoolkit.cpymadtools.specialmodule has been removed.The functions in
pyhdtoolkit.cpymadtools.plottersdo not enforce anyrcParamsanymore, and these are fully left to the user.The
pyhdtoolkit.cpymadtools.lhc.match_no_coupling_through_ripkens,pyhdtoolkit.cpymadtools.matching.get_closest_tune_approachandpyhdtoolkit.cpymadtools.matching.get_lhc_tune_and_chroma_knobsfunctions have been deprecated in favor of their counterparts in other modules. They will be removed in a future release.
See v0.16.0 release notes on GitHub and the full changes since v0.15.1.