|
| 1 | +.. _release_1.2.0: |
| 2 | + |
| 3 | +1.2.0 |
| 4 | +----- |
| 5 | + |
| 6 | +Release `1.2.0` brings some new features and dependency changes. |
| 7 | + |
| 8 | +Changes |
| 9 | +~~~~~~~ |
| 10 | + |
| 11 | +* The `pyhdtoolkit.plotting.envelope` functions `plot_envelope` and `plot_stay_clear` have been removed. They are replaced by a new one, `plot_beam_envelope`, which handles all enveloppe calculations directly from the `MAD-X` instance. Documentation and examples have been updated. |
| 12 | + |
| 13 | +Enhancements |
| 14 | +~~~~~~~~~~~~ |
| 15 | + |
| 16 | +* The `pyhdtoolkit.plotting.aperture` module has a new function, `~pyhdtoolkit.plotting.aperture.plot_physical_apertures`, to try and plot the physical apertures of elements on the given axis. |
| 17 | +* The `pyhdtoolkit.plotting.utils` module has a new function, `~pyhdtoolkit.plotting.utils.draw_confidence_ellipse`, to plot the covariance ellipse of two arrays. |
| 18 | +* The `pyhdtoolkit.plotting.layout.plot_machine_layout` function (and those relying on it) can now plot octupole patches. |
| 19 | +* The `pyhdtoolkit.plotting.layout.plot_machine_layout` function (and those relying on it) can now handle single values given for ylimits of different elements in the machine layout. For instance now `k1l_lim=5e-2` is valid and equivalent to `k1l_lim=(-5e-2, 5e-2)`. |
| 20 | +* An experimental utility function was added to split a complex-valued columns from a dataframe into two real-valued ones. It might join the public API in a future release, and is for now available as `~pyhdtoolkit.utils._misc.split_complex_columns`. |
| 21 | +* An experimental utility function was added to add noise to the ``LHC`` *IR* BPMs in a given dataframe column. It might join the public API in a future release, and is for now available as `~pyhdtoolkit.utils._misc.add_noise_to_ir_bpms`. |
| 22 | +* An experimental utility function was added to add noise to the ``LHC`` *arc* BPMs in a given dataframe column. It might join the public API in a future release, and is for now available as `~pyhdtoolkit.utils._misc.add_noise_to_arc_bpms`. |
| 23 | +* The functions in the `pyhdtoolkit.cpymadtools.ptc` module can now be given values for the ``PTC`` universe creation and called commands parameters through keyword arguments. The documentation has been updated with information on the available parameters. |
| 24 | + |
| 25 | +Bug Fixes |
| 26 | +~~~~~~~~~ |
| 27 | + |
| 28 | +* The `pyhdtoolkit.plotting.layout.plot_machine_layout` function now only adds a legend for element patches of a certain type if at least one element was drawn. |
| 29 | +* The `pyhdtoolkit.plotting.layout.plot_machine_layout` function now tries to properly determine legend locations based on which elements were drawn. |
| 30 | + |
| 31 | +Documentation |
| 32 | +~~~~~~~~~~~~~ |
| 33 | + |
| 34 | +* The documentation generated by `Sphinx` should now properly display short type hints instead of the full expanded ones. |
| 35 | +* Some example pages have been updated to use the minimal requirement of provided **args** for the functions in `~pyhdtoolkit.cpymadtools.matching`. |
| 36 | +* Some typos that were left in a few docstrings have been corrected. |
| 37 | + |
| 38 | +Maintenance |
| 39 | +~~~~~~~~~~~ |
| 40 | + |
| 41 | +* The `madx` argument is now positional only in all APIs involving it (APIs in `~pyhdtoolkit.cpymadtools` and `~pyhdtoolkit.plotting`). |
| 42 | +* The `~numpy` dependency is now capped at version `<1.24.0`, as when using this new version some `~matplotlib` functions are broken. |
| 43 | +* Various type hints from the `typing` module, such as `Dict` or `List`, have been superseeded by the default, now-standard builtins (such as `dict` or `list`). |
| 44 | + |
| 45 | +See `v1.2.0 release notes on GitHub <https://github.com/fsoubelet/PyhDToolkit/releases/tag/1.2.0>`_ and the `full changes since v1.1.1 <https://github.com/fsoubelet/PyhDToolkit/compare/1.1.1...1.2.0>`_. |
0 commit comments