Implement mittag_leffler model

docs/docs/tutorials/index.md

@@ -53,6 +53,9 @@ tutorials.
 - [DeltaLorentz](delta_lorentz.ipynb) – Learn how to create and use a
   model with a Delta function and a Lorentzian that have a shared
   Debye-Waller-like Q-dependence.
+- [Mittag-Leffler relaxation](mittag_leffler.ipynb) – Learn how to use
+  the multiscale relaxation model of Hassani et al. (2022), both as a
+  single lineshape and as a diffusion model across Q.
 - [Sample model](sample_model.ipynb) – Learn how to create a model of
   the scattering from your sample including model components and
   diffusion models.

docs/docs/user-guide/concept.md

@@ -19,8 +19,8 @@ a list of `ComponentCollection`s (one for each Q) describing the model
 of the measured data. A `ComponentCollection` is essentially a list of
 `ModelComponents`. A `ModelComponent` can be any of `Gaussian`,
 `Lorentzian`, `Voigt` (the convolution of a `Gaussian` and
-`Lorentzian`), `DeltaFunction`, `DampedHarmonicOscillator` and
-`Polynomium`.
+`Lorentzian`), `DeltaFunction`, `DampedHarmonicOscillator`,
+`DiffusionDampedMittagLeffler` and `Polynomium`.
 
 Each `ModelComponent` has a number of `Parameter`s. The `Gaussian`, for
 example, has `area`, `center` and `width`. Each of these `Parameter`s

docs/mkdocs.yml

@@ -212,6 +212,7 @@ nav:
           - Detailed balance: tutorials/detailed_balance.ipynb
           - DeltaLorentz: tutorials/delta_lorentz.ipynb
           - Diffusion model: tutorials/diffusion_model.ipynb
+          - Mittag-Leffler relaxation: tutorials/mittag_leffler.ipynb
           - Sample model: tutorials/sample_model.ipynb
           - Instrument model: tutorials/instrument_model.ipynb
           - Experiment: tutorials/experiment.ipynb

src/easydynamics/__init__.py

@@ -29,12 +29,14 @@
 from easydynamics.sample_model import DampedHarmonicOscillator
 from easydynamics.sample_model import DeltaFunction
 from easydynamics.sample_model import DeltaLorentz
+from easydynamics.sample_model import DiffusionDampedMittagLeffler
 from easydynamics.sample_model import Exponential
 from easydynamics.sample_model import ExpressionComponent
 from easydynamics.sample_model import Gaussian
 from easydynamics.sample_model import InstrumentModel
 from easydynamics.sample_model import JumpTranslationalDiffusion
 from easydynamics.sample_model import Lorentzian
+from easydynamics.sample_model import MittagLefflerDiffusion
 from easydynamics.sample_model import Polynomial
 from easydynamics.sample_model import ResolutionModel
 from easydynamics.sample_model import SampleModel
@@ -62,6 +64,7 @@
     'DeltaFunction',
     'DeltaLorentz',
     'DetailedBalanceSettings',
+    'DiffusionDampedMittagLeffler',
     'EasyDynamicsBase',
     'EasyDynamicsModelBase',
     'Experiment',
@@ -72,6 +75,7 @@
     'InstrumentModel',
     'JumpTranslationalDiffusion',
     'Lorentzian',
+    'MittagLefflerDiffusion',
     'MultiQPosteriorSampler',
     'ParameterAnalysis',
     'ParameterLabels',

src/easydynamics/sample_model/__init__.py

@@ -7,6 +7,9 @@
     DampedHarmonicOscillator,
 )
 from easydynamics.sample_model.components.delta_function import DeltaFunction
+from easydynamics.sample_model.components.diffusion_damped_mittag_leffler import (
+    DiffusionDampedMittagLeffler,
+)
 from easydynamics.sample_model.components.exponential import Exponential
 from easydynamics.sample_model.components.expression_component import ExpressionComponent
 from easydynamics.sample_model.components.gaussian import Gaussian
@@ -20,6 +23,9 @@
 from easydynamics.sample_model.diffusion_model.jump_translational_diffusion import (
     JumpTranslationalDiffusion,
 )
+from easydynamics.sample_model.diffusion_model.mittag_leffler_diffusion import (
+    MittagLefflerDiffusion,
+)
 from easydynamics.sample_model.instrument_model import InstrumentModel
 from easydynamics.sample_model.resolution_model import ResolutionModel
 from easydynamics.sample_model.sample_model import SampleModel
@@ -31,12 +37,14 @@
     'DampedHarmonicOscillator',
     'DeltaFunction',
     'DeltaLorentz',
+    'DiffusionDampedMittagLeffler',
     'Exponential',
     'ExpressionComponent',
     'Gaussian',
     'InstrumentModel',
     'JumpTranslationalDiffusion',
     'Lorentzian',
+    'MittagLefflerDiffusion',
     'Polynomial',
     'ResolutionModel',
     'SampleModel',

src/easydynamics/sample_model/components/__init__.py

@@ -5,6 +5,9 @@
     DampedHarmonicOscillator,
 )
 from easydynamics.sample_model.components.delta_function import DeltaFunction
+from easydynamics.sample_model.components.diffusion_damped_mittag_leffler import (
+    DiffusionDampedMittagLeffler,
+)
 from easydynamics.sample_model.components.exponential import Exponential
 from easydynamics.sample_model.components.expression_component import ExpressionComponent
 from easydynamics.sample_model.components.gaussian import Gaussian
@@ -15,6 +18,7 @@
 __all__ = [
     'DampedHarmonicOscillator',
     'DeltaFunction',
+    'DiffusionDampedMittagLeffler',
     'Exponential',
     'ExpressionComponent',
     'Gaussian',