Check Corrections

CHANGELOG.md

@@ -1,5 +1,17 @@
 # OMC3 Changelog
 
+#### 2023-05-15 - v0.10.0 - _jdilly_
+- Added:
+  - `omc3.check_corrections`: A new feature to check the validity of corrections.
+  - `omc3.plotting.plot_checked_corrections`: Function to plot the checked corrections.
+  - Unified optics-columns naming in `omc3.definitions.optics`
+    (but not yet propagated through the code)
+  - Function to calculate RMS in `omc3.utils.stats.rms`.
+
+- Fixed:
+  - Some minor bugs with fake datatypes
+  - Doc of `ArrayType` typehints
+
 #### 2023-04-27 - v0.9.0 - _jdilly_
 
 - Added:

doc/conf.py

@@ -93,7 +93,7 @@
 #
 # This is also used if you do content translation via gettext catalogs.
 # Usually you set "language" from the command line for these cases.
-language = None
+language = "en"
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
@@ -230,3 +230,10 @@
 autodoc_mock_imports = ['PyQt5', 'PyQt5.QtGui', 'PyQt5.QtCore', 'PyQt5.QtWidgets',
                         "matplotlib.backends.backend_qt5agg",
                         ]
+
+# -- Type Aliases --------------------------------------------------------------
+
+# This is to tell Sphinx how to print some specific type annotations
+# See: https://stackoverflow.com/a/67483317
+# See: https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html#confval-autodoc_type_aliases
+autodoc_type_aliases = {"ArrayLike": "ArrayLike"}

doc/entrypoints/correction.rst

@@ -6,3 +6,6 @@ Correction
 
 .. automodule:: omc3.response_creator
     :members:
+
+.. automodule:: omc3.check_corrections
+    :members:

doc/entrypoints/plotting.rst

@@ -10,6 +10,9 @@ Plotting
 .. automodule:: omc3.plotting.plot_spectrum
     :members:
 
+.. automodule:: omc3.plotting.plot_checked_corrections
+    :members:
+
 .. automodule:: omc3.plotting.plot_amplitude_detuning
     :members:
 

omc3/__init__.py

@@ -11,7 +11,7 @@
 __title__ = "omc3"
 __description__ = "An accelerator physics tools package for the OMC team at CERN."
 __url__ = "https://github.com/pylhc/omc3"
-__version__ = "0.9.0"
+__version__ = "0.10.0"
 __author__ = "pylhc"
 __author_email__ = "[email protected]"
 __license__ = "MIT"