ComponentCollection

examples/component_collection.ipynb

@@ -0,0 +1,131 @@
+{
+ "cells": [
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "64deaa41",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "import numpy as np\n",
+    "\n",
+    "from easydynamics.sample_model import Gaussian\n",
+    "from easydynamics.sample_model import Lorentzian\n",
+    "from easydynamics.sample_model import DampedHarmonicOscillator\n",
+    "from easydynamics.sample_model import Polynomial\n",
+    "\n",
+    "from easydynamics.sample_model import ComponentCollection\n",
+    "\n",
+    "\n",
+    "import matplotlib.pyplot as plt\n",
+    "\n",
+    "\n",
+    "%matplotlib widget"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "f2d27900",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from scipy.integrate import simpson\n",
+    "\n",
+    "model = ComponentCollection(display_name=\"TestComponentCollection\")\n",
+    "component1 = Gaussian(\n",
+    "    display_name=\"TestGaussian1\",\n",
+    "    area=1.0,\n",
+    "    center=0.0,\n",
+    "    width=1.0,\n",
+    "    unit=\"meV\",\n",
+    "    unique_name=\"TestGaussian1\",\n",
+    ")\n",
+    "component2 = Lorentzian(\n",
+    "    display_name=\"TestLorentzian1\",\n",
+    "    area=2.0,\n",
+    "    center=1.0,\n",
+    "    width=0.5,\n",
+    "    unit=\"meV\",\n",
+    "    unique_name=\"TestLorentzian1\",\n",
+    ")\n",
+    "model.add_component(component1)\n",
+    "model.add_component(component2)\n",
+    "\n",
+    "model.normalize_area()\n",
+    "# EXPECT\n",
+    "x = np.linspace(-10000, 10000, 1000000)  # Lorentzians have long tails\n",
+    "result = model.evaluate(x)\n",
+    "numerical_area = simpson(result, x)\n",
+    "\n",
+    "print(numerical_area)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "fe3b8780",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "model.components[1].area"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "784d9e82",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "component_collection=ComponentCollection()\n",
+    "\n",
+    "# Creating components\n",
+    "gaussian=Gaussian(display_name='Gaussian',width=0.5,area=1)\n",
+    "dho = DampedHarmonicOscillator(display_name='DHO',center=1.0,width=0.3,area=2.0)\n",
+    "lorentzian = Lorentzian(display_name='Lorentzian',center=-1.0,width=0.2,area=1.0)\n",
+    "polynomial = Polynomial(display_name='Polynomial',coefficients=[0.1, 0, 0.5])  # y=0.1+0.5*x^2\n",
+    "\n",
+    "# Adding components to the component collection\n",
+    "component_collection.add_component(gaussian)\n",
+    "component_collection.add_component(dho)\n",
+    "component_collection.add_component(lorentzian)\n",
+    "component_collection.add_component(polynomial)\n",
+    "\n",
+    "x=np.linspace(-2, 2, 100)\n",
+    "\n",
+    "plt.figure()\n",
+    "y=component_collection.evaluate(x)\n",
+    "plt.plot(x, y, label='Component collection')\n",
+    "\n",
+    "for component in component_collection.components:\n",
+    "    y = component.evaluate(x)\n",
+    "    plt.plot(x, y, label=component.display_name)\n",
+    "\n",
+    "plt.legend()\n",
+    "plt.show()"
+   ]
+  }
+ ],
+ "metadata": {
+  "kernelspec": {
+   "display_name": "easydynamics_newbase",
+   "language": "python",
+   "name": "python3"
+  },
+  "language_info": {
+   "codemirror_mode": {
+    "name": "ipython",
+    "version": 3
+   },
+   "file_extension": ".py",
+   "mimetype": "text/x-python",
+   "name": "python",
+   "nbconvert_exporter": "python",
+   "pygments_lexer": "ipython3",
+   "version": "3.12.12"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 5
+}

examples/component_example.ipynb → examples/components.ipynb

@@ -19,7 +19,7 @@
     "import matplotlib.pyplot as plt\n",
     "\n",
     "\n",
-    "%matplotlib widget"
+    "%matplotlib widget\n"
    ]
   },
   {
@@ -30,10 +30,10 @@
    "outputs": [],
    "source": [
     "# Creating a component\n",
-    "gaussian=Gaussian(name='Gaussian',width=0.5,area=1)\n",
-    "dho = DampedHarmonicOscillator(name='DHO',center=1.0,width=0.3,area=2.0)\n",
-    "lorentzian = Lorentzian(name='Lorentzian',center=-1.0,width=0.2,area=1.0)\n",
-    "polynomial = Polynomial(name='Polynomial',coefficients=[0.1, 0, 0.5])  # y=0.1+0.5*x^2\n",
+    "gaussian=Gaussian(display_name='Gaussian',width=0.5,area=1)\n",
+    "dho = DampedHarmonicOscillator(display_name='DHO',center=1.0,width=0.3,area=2.0)\n",
+    "lorentzian = Lorentzian(display_name='Lorentzian',center=-1.0,width=0.2,area=1.0)\n",
+    "polynomial = Polynomial(display_name='Polynomial',coefficients=[0.1, 0, 0.5])  # y=0.1+0.5*x^2\n",
     "\n",
     "x=np.linspace(-2, 2, 100)\n",
     "\n",
@@ -72,7 +72,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "delta = DeltaFunction(name='Delta', center=0.0, area=1.0)\n",
+    "delta = DeltaFunction(display_name='Delta', center=0.0, area=1.0)\n",
     "x1=np.linspace(-2, 2, 100)\n",
     "y=delta.evaluate(x1)\n",
     "x2=np.linspace(-2,2,51)\n",
@@ -100,7 +100,7 @@
     "x1=sc.linspace(dim='x', start=-2.0, stop=2.0, num=100, unit='meV')\n",
     "x2=sc.linspace(dim='x', start=-2.0*1e3, stop=2.0*1e3, num=101, unit='microeV')\n",
     "\n",
-    "polynomial = Polynomial(name='Polynomial',coefficients=[0.1, 0, 0.5])  # y=0.1+0.5*x^2\n",
+    "polynomial = Polynomial(display_name='Polynomial',coefficients=[0.1, 0, 0.5])  # y=0.1+0.5*x^2\n",
     "y1=polynomial.evaluate(x1)\n",
     "y2=polynomial.evaluate(x2)\n",
     "\n",
@@ -114,7 +114,7 @@
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "newdynamics",
+   "display_name": "easydynamics_newbase",
    "language": "python",
    "name": "python3"
   },
@@ -128,7 +128,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.11.13"
+   "version": "3.12.12"
   }
  },
  "nbformat": 4,

src/easydynamics/sample_model/__init__.py

@@ -1,3 +1,4 @@
+from .component_collection import ComponentCollection
 from .components import (
     DampedHarmonicOscillator,
     DeltaFunction,
@@ -8,7 +9,7 @@
 )
 
 __all__ = [
-    "SampleModel",
+    "ComponentCollection",
     "Gaussian",
     "Lorentzian",
     "Voigt",