Update all ConfigModel classes to numpy-docstring format

Copilot · gubaidulinvadim · Copilot · commit d96a9badc864 · 2026-01-12T09:09:53.000Z
Co-authored-by: gubaidulinvadim &lt;2589030+gubaidulinvadim@users.noreply.github.com&gt;
diff --git a/pyaml/accelerator.py b/pyaml/accelerator.py
@@ -19,26 +19,41 @@
 
 
 class ConfigModel(BaseModel):
+    """
+    Configuration model for Accelerator
+
+    Parameters
+    ----------
+    facility : str
+        Facility name
+    machine : str
+        Accelerator name
+    energy : float
+        Accelerator nominal energy. For ramped machine,
+        this value can be dynamically set
+    controls : list[ControlSystem], optional
+        List of control system used. An accelerator
+        can access several control systems
+    simulators : list[Simulator], optional
+        Simulator list
+    data_folder : str
+        Data folder
+    arrays : list[ArrayConfig], optional
+        Element family
+    devices : list[Element]
+        Element list
+    """
+
     model_config = ConfigDict(arbitrary_types_allowed=True, extra="forbid")
 
     facility: str
-    "Facility name"
     machine: str
-    """Accelerator name"""
     energy: float
-    """Accelerator nominal energy, for ramped machine,
-       this value can be dynamically set"""
     controls: list[ControlSystem] = None
-    """List of control system used, an accelerator
-       can access several control systems"""
     simulators: list[Simulator] = None
-    """Simulator list"""
     data_folder: str
-    """Data folder"""
     arrays: list[ArrayConfig] = None
-    """Element family"""
     devices: list[Element]
-    """Element list"""
 
 
 class Accelerator(object):
diff --git a/pyaml/arrays/array.py b/pyaml/arrays/array.py
@@ -11,13 +11,13 @@
 
 class ArrayConfigModel(BaseModel):
     """
-    Base class for array confirguration
+    Base class for array configuration
 
-    Parameters:
-    -----------
-    name: str
+    Parameters
+    ----------
+    name : str
         Family name
-    elements: list[str]
+    elements : list[str]
         List of pyaml element names
     """
 
diff --git a/pyaml/bpm/bpm_simple_model.py b/pyaml/bpm/bpm_simple_model.py
@@ -12,12 +12,21 @@
 
 
 class ConfigModel(BaseModel):
+    """
+    Configuration model for BPM simple model
+
+    Parameters
+    ----------
+    x_pos : DeviceAccess, optional
+        Horizontal position device
+    y_pos : DeviceAccess, optional
+        Vertical position device
+    """
+
     model_config = ConfigDict(arbitrary_types_allowed=True, extra="forbid")
 
     x_pos: DeviceAccess | None
-    """Horizontal position"""
     y_pos: DeviceAccess | None
-    """Vertical position"""
 
 
 class BPMSimpleModel(BPMModel):
diff --git a/pyaml/bpm/bpm_tiltoffset_model.py b/pyaml/bpm/bpm_tiltoffset_model.py
@@ -13,18 +13,30 @@
 
 
 class ConfigModel(BaseModel):
+    """
+    Configuration model for BPM with tilt and offset
+
+    Parameters
+    ----------
+    x_pos : DeviceAccess, optional
+        Horizontal position device
+    y_pos : DeviceAccess, optional
+        Vertical position device
+    x_offset : DeviceAccess, optional
+        Horizontal BPM offset device
+    y_offset : DeviceAccess, optional
+        Vertical BPM offset device
+    tilt : DeviceAccess, optional
+        BPM tilt device
+    """
+
     model_config = ConfigDict(arbitrary_types_allowed=True, extra="forbid")
 
     x_pos: DeviceAccess | None
-    """Horizontal position"""
     y_pos: DeviceAccess | None
-    """Vertical position"""
     x_offset: DeviceAccess | None
-    """Horizontal BPM offset"""
     y_offset: DeviceAccess | None
-    """Vertical BPM offset"""
     tilt: DeviceAccess | None
-    """BPM tilt"""
 
 
 class BPMTiltOffsetModel(BPMSimpleModel):
diff --git a/pyaml/configuration/csvcurve.py b/pyaml/configuration/csvcurve.py
@@ -12,10 +12,18 @@
 
 
 class ConfigModel(BaseModel):
+    """
+    Configuration model for CSV curve
+
+    Parameters
+    ----------
+    file : str
+        CSV file that contains the curve (n rows, 2 columns)
+    """
+
     model_config = ConfigDict(arbitrary_types_allowed=True, extra="forbid")
 
     file: str
-    """CSV file that contains the curve (n rows,2 columns)"""
 
 
 class CSVCurve(Curve):
diff --git a/pyaml/configuration/csvmatrix.py b/pyaml/configuration/csvmatrix.py
@@ -12,10 +12,18 @@
 
 
 class ConfigModel(BaseModel):
+    """
+    Configuration model for CSV matrix
+
+    Parameters
+    ----------
+    file : str
+        CSV file that contains the matrix
+    """
+
     model_config = ConfigDict(arbitrary_types_allowed=True, extra="forbid")
 
     file: str
-    """CSV file that contains the matrix"""
 
 
 class CSVMatrix(Matrix):
diff --git a/pyaml/configuration/inline_curve.py b/pyaml/configuration/inline_curve.py
@@ -12,10 +12,18 @@
 
 
 class ConfigModel(BaseModel):
+    """
+    Configuration model for inline curve
+
+    Parameters
+    ----------
+    mat : list[list[float]]
+        Curve data (n rows, 2 columns)
+    """
+
     model_config = ConfigDict(arbitrary_types_allowed=True, extra="forbid")
 
     mat: list[list[float]]
-    """CSV file that contains the curve (n rows,2 columns)"""
 
 
 class InlineCurve(Curve):
diff --git a/pyaml/configuration/inline_matrix.py b/pyaml/configuration/inline_matrix.py
@@ -8,10 +8,18 @@
 
 
 class ConfigModel(BaseModel):
+    """
+    Configuration model for inline matrix
+
+    Parameters
+    ----------
+    mat : list[list[float]]
+        The matrix
+    """
+
     model_config = ConfigDict(arbitrary_types_allowed=True, extra="forbid")
 
     mat: list[list[float]]
-    """The matrix"""
 
 
 class InlineMatrix(Matrix):
diff --git a/pyaml/lattice/simulator.py b/pyaml/lattice/simulator.py
@@ -50,16 +50,27 @@
 
 
 class ConfigModel(BaseModel):
+    """
+    Configuration model for Simulator
+
+    Parameters
+    ----------
+    name : str
+        Simulator name
+    lattice : str
+        AT lattice file
+    mat_key : str, optional
+        AT lattice ring name
+    linker : LatticeElementsLinker, optional
+        The linker configuration model
+    """
+
     model_config = ConfigDict(arbitrary_types_allowed=True, extra="forbid")
 
     name: str
-    """Simulator name"""
     lattice: str
-    """AT lattice file"""
     mat_key: str = None
-    """AT lattice ring name"""
     linker: LatticeElementsLinker = None
-    """The linker configuration model"""
 
 
 class Simulator(ElementHolder):
diff --git a/pyaml/magnet/identity_cfm_model.py b/pyaml/magnet/identity_cfm_model.py
@@ -11,16 +11,27 @@
 
 
 class ConfigModel(BaseModel):
+    """
+    Configuration model for identity combined function magnet model
+
+    Parameters
+    ----------
+    multipoles : list[str]
+        List of supported functions: A0, B0, A1, B1, etc (i.e. [B0, A1, B2])
+    powerconverters : list[DeviceAccess], optional
+        Power converter devices to apply current
+    physics : list[DeviceAccess], optional
+        Magnet devices to apply strength
+    units : list[str]
+        List of strength units (i.e. ['rad', 'm-1', 'm-2'])
+    """
+
     model_config = ConfigDict(arbitrary_types_allowed=True, extra="forbid")
 
     multipoles: list[str]
-    """List of supported functions: A0,B0,A1,B1,etc (i.e. [B0,A1,B2])"""
     powerconverters: list[DeviceAccess | None] | None = None
-    """Power converter device to apply current"""
     physics: list[DeviceAccess | None] | None = None
-    """Magnet device to apply strength"""
     units: list[str]
-    """List of strength unit (i.e. ['rad','m-1','m-2'])"""
 
 
 class IdentityCFMagnetModel(MagnetModel):
diff --git a/pyaml/magnet/identity_model.py b/pyaml/magnet/identity_model.py
@@ -11,14 +11,24 @@
 
 
 class ConfigModel(BaseModel):
+    """
+    Configuration model for identity magnet model
+
+    Parameters
+    ----------
+    powerconverter : DeviceAccess, optional
+        Power converter device to apply current
+    physics : DeviceAccess, optional
+        Magnet device to apply strength
+    unit : str
+        Unit of the strength (i.e. 1/m or m-1)
+    """
+
     model_config = ConfigDict(arbitrary_types_allowed=True, extra="forbid")
 
     powerconverter: DeviceAccess | None = None
-    """Power converter device to apply current"""
     physics: DeviceAccess | None = None
-    """Magnet device to apply strength"""
     unit: str
-    """Unit of the strength (i.e. 1/m or m-1)"""
 
 
 class IdentityMagnetModel(MagnetModel):
diff --git a/pyaml/magnet/linear_cfm_model.py b/pyaml/magnet/linear_cfm_model.py
@@ -13,32 +13,48 @@
 
 
 class ConfigModel(BaseModel):
+    """
+    Configuration model for linear combined function magnet model
+
+    Parameters
+    ----------
+    multipoles : list[str]
+        List of supported functions: A0, B0, A1, B1, etc (i.e. [B0, A1, B2])
+    curves : list[Curve]
+        Excitation curves, 1 curve per function
+    calibration_factors : list[float], optional
+        Correction factor applied to curves, 1 factor per function.
+        Default: ones
+    calibration_offsets : list[float], optional
+        Correction offset applied to curves, 1 offset per function.
+        Default: zeros
+    pseudo_factors : list[float], optional
+        Factors applied to 'pseudo currents', 1 factor per function.
+        Default: ones
+    pseudo_offsets : list[float], optional
+        Offsets applied to 'pseudo currents', 1 offset per function.
+        Default: zeros
+    powerconverters : list[DeviceAccess]
+        List of power converter devices to apply currents (can be different
+        from number of functions)
+    matrix : Matrix, optional
+        n x m matrix (n rows for n functions, m columns for m currents)
+        to handle multipoles separation. Default: Identity
+    units : list[str]
+        List of strength units (i.e. ['rad', 'm-1', 'm-2'])
+    """
+
     model_config = ConfigDict(arbitrary_types_allowed=True, extra="forbid")
 
     multipoles: list[str]
-    """List of supported functions: A0,B0,A1,B1,etc (i.e. [B0,A1,B2])"""
     curves: list[Curve]
-    """Exitacion curves, 1 curve per function"""
     calibration_factors: list[float] = None
-    """Correction factor applied to curves, 1 factor per function
-       Delfault: ones"""
     calibration_offsets: list[float] = None
-    """Correction offset applied to curves, 1 offset per function
-       Delfault: zeros"""
     pseudo_factors: list[float] = None
-    """Factors applied to 'pseudo currents', 1 factor per function.
-       Delfault: ones"""
     pseudo_offsets: list[float] = None
-    """Offsets applied to 'pseudo currents', 1 factor per function.
-       Delfault: zeros"""
     powerconverters: list[DeviceAccess | None]
-    """List of power converter devices to apply currents (can be different
-       from number of function)"""
     matrix: Matrix = None
-    """n x m matrix (n rows for n function , m columns for m currents)
-       to handle multipoles separation. Default: Identity"""
     units: list[str]
-    """List of strength unit (i.e. ['rad','m-1','m-2'])"""
 
 
 class LinearCFMagnetModel(MagnetModel):
diff --git a/pyaml/magnet/linear_serialized_model.py b/pyaml/magnet/linear_serialized_model.py
diff --git a/pyaml/magnet/spline_model.py b/pyaml/magnet/spline_model.py
diff --git a/pyaml/tuning_tools/dispersion.py b/pyaml/tuning_tools/dispersion.py
diff --git a/pyaml/tuning_tools/orbit_response_matrix.py b/pyaml/tuning_tools/orbit_response_matrix.py
diff --git a/pyaml/tuning_tools/response_matrix.py b/pyaml/tuning_tools/response_matrix.py
