Add name property to ModelComponents, DiffusionModels and ComponentCollections

docs/docs/tutorials/components.ipynb

@@ -168,7 +168,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.12.13"
+   "version": "3.14.4"
   }
  },
  "nbformat": 4,

docs/docs/tutorials/tutorial0_basics.ipynb

@@ -123,7 +123,7 @@
     "  </div>\n",
     "</details>\n",
     "\n",
-    "In this data we see a single Gaussian shaped peak and a background that seems to be zero on average. We now want to fit this data, e.g. to determine how the Gaussian changes with $Q$. We define a `Gaussian` like this:"
+    "In this data we see a single Gaussian shaped peak and a background that seems to be zero on average. We now want to fit this data, e.g. to determine how the Gaussian changes with $Q$. We define a `Gaussian` like this. The `name` will soon be used for indexing, while the `display_name` is what is displayed in figures. By defalut, `display_name` is the same as `name`."
    ]
   },
   {
@@ -133,7 +133,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "gaussian = sm.Gaussian(display_name='Gaussian', area=1, width=0.05)"
+    "gaussian = sm.Gaussian(name='Gaussian', area=1, width=0.05)"
    ]
   },
   {

docs/docs/tutorials/tutorial0_more_advanced.ipynb

@@ -73,9 +73,9 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "gaussian = sm.Gaussian(display_name='Gaussian', area=3, width=0.05)\n",
-    "lorentzian = sm.Lorentzian(display_name='Lorentzian', area=2, width=0.3)\n",
-    "dho = sm.DampedHarmonicOscillator(display_name='DHO', area=1.5, width=0.2, center=1.5)\n",
+    "gaussian = sm.Gaussian(name='Gaussian', area=3, width=0.05)\n",
+    "lorentzian = sm.Lorentzian(name='Lorentzian', area=2, width=0.3)\n",
+    "dho = sm.DampedHarmonicOscillator(name='DHO', area=1.5, width=0.2, center=1.5)\n",
     "\n",
     "collection = sm.ComponentCollection()\n",
     "collection.append_component(gaussian)\n",
@@ -245,7 +245,7 @@
    "id": "af4103fb",
    "metadata": {},
    "source": [
-    "The fit looks very good. We can again get a list of the parameters for this fit by accesing the corresponding `Analysis1d` object. Note ethat the Gaussian and Lorentzian centers are both zero, but that the `energy_offset` is non-zero."
+    "The fit looks very good. We can again get a list of the parameters for this fit by accesing the corresponding `Analysis1d` object. Note that the Gaussian and Lorentzian centers are both zero, but that the `energy_offset` is non-zero."
    ]
   },
   {

docs/docs/tutorials/tutorial1_brownian.ipynb

@@ -118,7 +118,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "delta_function = DeltaFunction(display_name='DeltaFunction', area=1)\n",
+    "delta_function = DeltaFunction(name='DeltaFunction', area=1)\n",
     "sample_model = SampleModel(components=delta_function)"
    ]
   },
@@ -142,7 +142,7 @@
    "outputs": [],
    "source": [
     "resolution_components = ComponentCollection()\n",
-    "res_gauss = Gaussian(width=0.1, area=1, display_name='Res. Gauss')\n",
+    "res_gauss = Gaussian(width=0.1, area=1, name='Res. Gauss')\n",
     "res_gauss.area.fixed = True\n",
     "resolution_components.append_component(res_gauss)\n",
     "resolution_model = ResolutionModel(components=resolution_components)"
@@ -350,8 +350,8 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "delta_function = DeltaFunction(display_name='DeltaFunction', area=0.2)\n",
-    "lorentzian = Lorentzian(display_name='Lorentzian', area=0.5, width=0.3)\n",
+    "delta_function = DeltaFunction(name='DeltaFunction', area=0.2)\n",
+    "lorentzian = Lorentzian(name='Lorentzian', area=0.5, width=0.3)\n",
     "component_collection = ComponentCollection(\n",
     "    components=[delta_function, lorentzian],\n",
     ")\n",
@@ -497,12 +497,12 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "delta_function = DeltaFunction(display_name='DeltaFunction', area=0.2)\n",
+    "delta_function = DeltaFunction(name='DeltaFunction', area=0.2)\n",
     "component_collection = ComponentCollection(\n",
     "    components=[delta_function],\n",
     ")\n",
     "diffusion_model = BrownianTranslationalDiffusion(\n",
-    "    display_name='Brownian Translational Diffusion', diffusion_coefficient=2.4e-9, scale=0.5\n",
+    "    name='Brownian Translational Diffusion', diffusion_coefficient=2.4e-9, scale=0.5\n",
     ")\n",
     "\n",
     "sample_model = SampleModel(\n",

docs/docs/tutorials/tutorial2_nanoparticles.ipynb

@@ -262,15 +262,15 @@
    "outputs": [],
    "source": [
     "sample_model = SampleModel()\n",
-    "water_delta_function = DeltaFunction(display_name='Water delta function', area=100)\n",
-    "water_lorentzian = Lorentzian(display_name='Water Lorentzian', area=10, width=0.2)\n",
+    "water_delta_function = DeltaFunction(name='Water delta function', area=100)\n",
+    "water_lorentzian = Lorentzian(name='Water Lorentzian', area=10, width=0.2)\n",
     "sample_model.append_component(water_delta_function)\n",
     "sample_model.append_component(water_lorentzian)\n",
     "sample_model.temperature = 150\n",
     "\n",
     "\n",
     "background_model = BackgroundModel()\n",
-    "polynomial = Polynomial(coefficients=[0.15])\n",
+    "polynomial = Polynomial(name='Polynomial', coefficients=[0.15])\n",
     "polynomial.coefficients[0].min = 0.0\n",
     "background_model.components = polynomial\n",
     "\n",
@@ -396,21 +396,21 @@
    "source": [
     "# Now make a new analysis with this sample model\n",
     "mag_sample_model = SampleModel()\n",
-    "water_delta_function = DeltaFunction(display_name='Water delta function', area=100)\n",
-    "water_lorentzian = Lorentzian(display_name='Water Lorentzian', area=100, width=0.2)\n",
+    "water_delta_function = DeltaFunction(name='Water delta function', area=100)\n",
+    "water_lorentzian = Lorentzian(name='Water Lorentzian', area=100, width=0.2)\n",
     "mag_sample_model.append_component(water_delta_function)\n",
     "mag_sample_model.append_component(water_lorentzian)\n",
     "\n",
     "# Add all the magnetic components\n",
-    "DHO1 = DampedHarmonicOscillator(display_name='DHO1', area=5, center=0.35, width=0.2)\n",
-    "DHO2 = DampedHarmonicOscillator(display_name='DHO2', area=1, center=1.1, width=0.1)\n",
-    "mag_lorz = Lorentzian(display_name='Magnetic Lorentzian', area=30, width=0.01)\n",
+    "DHO1 = DampedHarmonicOscillator(name='DHO1', area=5, center=0.35, width=0.2)\n",
+    "DHO2 = DampedHarmonicOscillator(name='DHO2', area=1, center=1.1, width=0.1)\n",
+    "mag_lorz = Lorentzian(name='Magnetic Lorentzian', area=30, width=0.01)\n",
     "mag_sample_model.append_component(DHO1)\n",
     "mag_sample_model.append_component(DHO2)\n",
     "mag_sample_model.append_component(mag_lorz)\n",
     "\n",
     "background_model = BackgroundModel()\n",
-    "polynomial = Polynomial(coefficients=[0.15])\n",
+    "polynomial = Polynomial(name='Polynomial', coefficients=[0.15])\n",
     "background_model.components = polynomial\n",
     "\n",
     "instrument_model = InstrumentModel(\n",

src/easydynamics/base_classes/easydynamics_base.py

@@ -9,61 +9,64 @@ class EasyDynamicsBase(NewBase):
 
     def __init__(
         self,
-        name: str | None = 'MyEasyDynamicsModel',
-        display_name: str | None = 'MyEasyDynamicsModel',
+        name: str = 'MyEasyDynamicsModel',
+        display_name: str | None = None,
         unique_name: str | None = None,
     ) -> None:
         """
         Initialize the EasyDynamicsBase.
 
         Parameters
         ----------
-        name : str | None, default='MyEasyDynamicsModel'
+        name : str, default='MyEasyDynamicsModel'
             Name of the model.
-        display_name : str | None, default='MyEasyDynamicsModel'
-            Display name of the model.
+        display_name : str | None, default=None
+            Display name of the model. If None, the name will be used.
         unique_name : str | None, default=None
             Unique name of the model. If None, a unique name will be generated.
 
         Raises
         ------
         TypeError
-            If name is not a string or None.
+            If name is not a string.
         """
-        super().__init__(display_name=display_name, unique_name=unique_name)
-
-        if name is not None and not isinstance(name, str):
-            raise TypeError('Name must be a string or None.')
+        if not isinstance(name, str):
+            raise TypeError('Name must be a string.')
         self._name = name
 
+        if display_name is None:
+            display_name = name
+
+        super().__init__(display_name=display_name, unique_name=unique_name)
+
     @property
-    def name(self) -> str | None:
+    def name(self) -> str:
         """
         Get the name of the model.
 
         Returns
         -------
-        str | None
+        str
             The name of the model.
         """
         return self._name
 
     @name.setter
-    def name(self, name_str: str | None) -> None:
+    def name(self, name_str: str) -> None:
         """
         Set the name of the model.
 
         Parameters
         ----------
-        name_str : str | None
+        name_str : str
             The new name to set.
 
         Raises
         ------
         TypeError
-            If name_str is not a string or None.
+            If name_str is not a string.
         """
 
-        if name_str is not None and not isinstance(name_str, str):
-            raise TypeError('Name must be a string or None.')
+        if not isinstance(name_str, str):
+            raise TypeError('Name must be a string.')
         self._name = name_str

src/easydynamics/base_classes/easydynamics_modelbase.py

@@ -13,8 +13,8 @@ class EasyDynamicsModelBase(ModelBase):
     def __init__(
         self,
         unit: str | sc.Unit = 'meV',
-        name: str | None = 'MyEasyDynamicsModel',
-        display_name: str | None = 'MyEasyDynamicsModel',
+        name: str = 'MyEasyDynamicsModel',
+        display_name: str | None = None,
         unique_name: str | None = None,
     ) -> None:
         """
@@ -24,25 +24,28 @@ def __init__(
         ----------
         unit : str | sc.Unit, default='meV'
             Unit of the model.
-        name : str | None, default='MyEasyDynamicsModel'
+        name : str, default='MyEasyDynamicsModel'
             Name of the model.
-        display_name : str | None, default='MyEasyDynamicsModel'
-            Display name of the model.
+        display_name : str | None, default=None
+            Display name of the model. If None, the name will be used.
         unique_name : str | None, default=None
             Unique name of the model. If None, a unique name will be generated.
 
         Raises
         ------
         TypeError
-            If name is not a string or None.
+            If name is not a string.
         """
+        if not isinstance(name, str):
+            raise TypeError('Name must be a string.')
+        self._name = name
+
+        if display_name is None:
+            display_name = name
+
         super().__init__(display_name=display_name, unique_name=unique_name)
         self._unit = _validate_unit(unit)
 
-        if name is not None and not isinstance(name, str):
-            raise TypeError('Name must be a string or None.')
-        self._name = name
-
     @property
     def unit(self) -> str | sc.Unit | None:
         """
@@ -77,13 +80,13 @@ def unit(self, _unit_str: str) -> None:
         )
 
     @property
-    def name(self) -> str | None:
+    def name(self) -> str:
         """
         Get the name of the model.
 
         Returns
         -------
-        str | None
+        str
             The name of the model.
         """
         return self._name
@@ -101,9 +104,9 @@ def name(self, name_str: str) -> None:
         Raises
         ------
         TypeError
-            If name_str is not a string or None.
+            If name_str is not a string.
         """
 
-        if name_str is not None and not isinstance(name_str, str):
-            raise TypeError('Name must be a string or None.')
+        if not isinstance(name_str, str):
+            raise TypeError('Name must be a string.')
         self._name = name_str