Complete the description attribute for all parameters (#95)

* Create a new fitting module directory

* Reorganizes fitting tracker module structure

* Refactors minimizer structure and imports

* Refactors reliability factors into metrics module

* Reorganizes import statements for clarity

* Enforces absolute imports for consistency

* Updates pixi.lock

* Pins dependencies in pixi.toml

* Reorganizes import statements in minimization module

* Adds descriptions to parameters and descriptors

Author: AndrewSazonov

src/easydiffraction/experiments/collections/background.py

@@ -31,7 +31,11 @@ def category_key(self) -> str:
     def cif_category_key(self) -> str:
         return 'pd_background'
 
-    def __init__(self, x: float, y: float):
+    def __init__(
+        self,
+        x: float,
+        y: float,
+    ):
         super().__init__()
 
         self.x = Descriptor(
@@ -69,7 +73,11 @@ def category_key(self) -> str:
     def cif_category_key(self):
         return 'pd_background'
 
-    def __init__(self, order: int, coef: float) -> None:
+    def __init__(
+        self,
+        order: int,
+        coef: float,
+    ) -> None:
         super().__init__()
 
         self.order = Descriptor(

src/easydiffraction/experiments/collections/excluded_regions.py

@@ -21,18 +21,24 @@ def category_key(self) -> str:
     def cif_category_key(self) -> str:
         return 'excluded_region'
 
-    def __init__(self, start: float, end: float):
+    def __init__(
+        self,
+        start: float,
+        end: float,
+    ):
         super().__init__()
 
         self.start = Descriptor(
             value=start,
             name='start',
             cif_name='start',
+            description='Start of the excluded region.',
         )
         self.end = Parameter(
             value=end,
             name='end',
             cif_name='end',
+            description='End of the excluded region.',
         )
 
         # Select which of the input parameters is used for the

src/easydiffraction/experiments/collections/linked_phases.py

@@ -18,18 +18,24 @@ def category_key(self) -> str:
     def cif_category_key(self) -> str:
         return 'pd_phase_block'
 
-    def __init__(self, id: str, scale: float):
+    def __init__(
+        self,
+        id: str,
+        scale: float,
+    ):
         super().__init__()
 
         self.id = Descriptor(
             value=id,
             name='id',
             cif_name='id',
+            description='Identifier of the linked phase.',
         )
         self.scale = Parameter(
             value=scale,
             name='scale',
             cif_name='scale',
+            description='Scale factor of the linked phase.',
         )
 
         # Select which of the input parameters is used for the

src/easydiffraction/sample_models/collections/atom_sites.py

@@ -38,47 +38,56 @@ def __init__(
             value=label,
             name='label',
             cif_name='label',
+            description='Unique identifier for the atom site.',
         )
         self.type_symbol = Descriptor(
             value=type_symbol,
             name='type_symbol',
             cif_name='type_symbol',
+            description='Chemical symbol of the atom at this site.',
         )
         self.adp_type = Descriptor(
             value=adp_type,
             name='adp_type',
             cif_name='ADP_type',
+            description='Type of atomic displacement parameter (ADP) used (e.g., Biso, Uiso, Uani, Bani).',
         )
         self.wyckoff_letter = Descriptor(
             value=wyckoff_letter,
             name='wyckoff_letter',
             cif_name='Wyckoff_letter',
+            description='Wyckoff letter indicating the symmetry of the atom site within the space group.',
         )
         self.fract_x = Parameter(
             value=fract_x,
             name='fract_x',
             cif_name='fract_x',
+            description='Fractional x-coordinate of the atom site within the unit cell.',
         )
         self.fract_y = Parameter(
             value=fract_y,
             name='fract_y',
             cif_name='fract_y',
+            description='Fractional y-coordinate of the atom site within the unit cell.',
         )
         self.fract_z = Parameter(
             value=fract_z,
             name='fract_z',
             cif_name='fract_z',
+            description='Fractional z-coordinate of the atom site within the unit cell.',
         )
         self.occupancy = Parameter(
             value=occupancy,
             name='occupancy',
             cif_name='occupancy',
+            description='Occupancy of the atom site, representing the fraction of the site occupied by the atom type.',
         )
         self.b_iso = Parameter(
             value=b_iso,
             name='b_iso',
             units='Ų',
             cif_name='B_iso_or_equiv',
+            description='Isotropic atomic displacement parameter (ADP) for the atom site.',
         )
         # Select which of the input parameters is used for the
         # as ID for the whole object

src/easydiffraction/sample_models/components/cell.py

@@ -34,36 +34,42 @@ def __init__(
             name='length_a',
             cif_name='length_a',
             units='Å',
+            description='Length of the unit cell edge a.',
         )
         self.length_b = Parameter(
             value=length_b,
             name='length_b',
             cif_name='length_b',
             units='Å',
+            description='Length of the unit cell edge b.',
         )
         self.length_c = Parameter(
             value=length_c,
             name='length_c',
             cif_name='length_c',
             units='Å',
+            description='Length of the unit cell edge c.',
         )
         self.angle_alpha = Parameter(
             value=angle_alpha,
             name='angle_alpha',
             cif_name='angle_alpha',
             units='deg',
+            description='Angle between edges b and c.',
         )
         self.angle_beta = Parameter(
             value=angle_beta,
             name='angle_beta',
             cif_name='angle_beta',
             units='deg',
+            description='Angle between edges a and c.',
         )
         self.angle_gamma = Parameter(
             value=angle_gamma,
             name='angle_gamma',
             cif_name='angle_gamma',
             units='deg',
+            description='Angle between edges a and b.',
         )
 
         # Lock further attribute additions to prevent

src/easydiffraction/sample_models/components/space_group.py

@@ -31,11 +31,13 @@ def __init__(
             value=name_h_m,
             name='name_h_m',
             cif_name='name_H-M_alt',
+            description='Hermann-Mauguin symbol of the space group.',
         )
         self.it_coordinate_system_code = Descriptor(
             value=it_coordinate_system_code,
             name='it_coordinate_system_code',
             cif_name='IT_coordinate_system_code',
+            description='A qualifier identifying which setting in IT is used.',
         )
 
         # Lock further attribute additions to prevent