Fix release: fix dipole angle limits determination (#105)

Author: fsoubelet

Diff for: docs/release.rst

@@ -3,6 +3,14 @@ Release Notes
 
 The full list of releases can be found in the GitHub repository's `releases page <https://github.com/fsoubelet/PyhDToolkit/releases>`_.
 
+Version 1.3.1
+-------------
+
+.. toctree::
+    :maxdepth: 2
+
+    releases/v1.3.1
+
 Version 1.3.0
 -------------
 

Diff for: docs/releases/v1.3.1.rst

@@ -0,0 +1,13 @@
+.. _release_1.3.1:
+
+1.3.1
+-----
+
+Release `1.3.1` is a light bug fix.
+
+Bug Fixes
+~~~~~~~~~
+
+* The `pyhdtoolkit.plotting.layout.plot_machine_layout` function will now correctly auto-determine y-axis limits for dipoles if the `angle` attribute is used for their powering. This assumes only one of `k0l` and `angle` is used for all dipoles and gives priority to the former when determining limits. Dipole patches elements are plotted no matter which variable is used.
+
+See `v1.3.1 release notes on GitHub <https://github.com/fsoubelet/PyhDToolkit/releases/tag/1.3.1>`_ and the `full changes since v1.3.0 <https://github.com/fsoubelet/PyhDToolkit/compare/1.3.0...1.3.1>`_.

Diff for: pyhdtoolkit/plotting/layout.py

@@ -148,10 +148,12 @@ def plot_machine_layout(
     bpms_df = element_dfs["bpms"]
 
     logger.trace("Determining the ylimits for k0l and k1l patches")
+    # Assume lattice doesnt mix 'k0l' and 'angle' for dipoles powering
+    dipoles_power_column = "k0l" if dipoles_df.k0l.any() else "angle"
     k0l_lim = (
         _ylim_from_input(k0l_lim, "k0l_lim")
         if k0l_lim is not None
-        else _determine_default_knl_lim(dipoles_df, col="k0l", coeff=2)
+        else _determine_default_knl_lim(dipoles_df, col=dipoles_power_column, coeff=2)
     )
     k1l_lim = (
         _ylim_from_input(k1l_lim, "k1l_lim")
@@ -182,7 +184,7 @@ def plot_machine_layout(
         plotted_elements = 0  # will help us not declare a label for legend at every patch
         for dipole_name, dipole in dipoles_df.iterrows():
             logger.trace(f"Plotting dipole element '{dipole_name}'")
-            bend_value = dipole.k0l if dipole.k0l != 0 else dipole.angle
+            bend_value = dipole.k0l if dipole.k0l != 0 else dipole.angle  # check for each element
             _plot_lattice_series(
                 dipole_patches_axis,
                 dipole,

Diff for: pyhdtoolkit/version.py

@@ -1,4 +1,4 @@
-VERSION = "1.3.0"
+VERSION = "1.3.1"
 
 
 def version_info() -> str: