Skip to content

Commit 948fd84

Browse files
Update doc strings
1 parent 20ce0fe commit 948fd84

File tree

5 files changed

+13
-3
lines changed

5 files changed

+13
-3
lines changed

src/easydynamics/sample_model/components/damped_harmonic_oscillator.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,9 +23,11 @@ class DampedHarmonicOscillator(ModelComponent):
2323
Damped Harmonic Oscillator (DHO). 2*area*center^2*width/pi / ( (x^2 - center^2)^2 + (2*width*x)^2 )
2424
2525
Args:
26+
name (str): Name of the component.
2627
center (Int or float): Resonance frequency, approximately the peak position.
2728
width (Int or float): Damping constant, approximately the half width at half max (HWHM) of the peaks.
2829
area (Int or float): Area under the curve.
30+
unit (str or sc.Unit): Unit of the parameters. Defaults to "meV".
2931
"""
3032

3133
def __init__(

src/easydynamics/sample_model/components/delta_function.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,10 @@ class DeltaFunction(ModelComponent):
2121
Delta function. Evaluates to zero everywhere, except in convolutions, where it acts as an identity. This is handled in the ResolutionHandler.
2222
2323
Args:
24+
name (str): Name of the component.
2425
center (Int or float or None): Center of the delta function. If None, defaults to 0 and is fixed.
2526
area (Int or float): Total area under the curve.
27+
unit (str or sc.Unit): Unit of the parameters. Defaults to "meV".
2628
"""
2729

2830
def __init__(

src/easydynamics/sample_model/components/gaussian.py

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,9 +23,11 @@ class Gaussian(ModelComponent):
2323
Gaussian function: area/(width*sqrt(2pi)) * exp(-0.5*((x - center)/width)^2)
2424
2525
Args:
26-
area (Int or float): Area of the Gaussian. Has the same unit as the x axis
26+
name (str): Name of the component.
27+
area (Int or float): Area of the Gaussian.
2728
center (Int or float or None): Center of the Gaussian. If None, defaults to 0 and is fixed
2829
width (Int or float): Standard deviation.
30+
unit (str or sc.Unit): Unit of the parameters. Defaults to "meV".
2931
"""
3032

3133
def __init__(

src/easydynamics/sample_model/components/lorentzian.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,9 +23,11 @@ class Lorentzian(ModelComponent):
2323
Lorentzian function: area*width / (pi * ( (x - center)^2 + width^2 ) )
2424
2525
Args:
26+
name (str): Name of the component.
2627
area (Int or float): Area of the Lorentzian.
2728
center (Int or float or None): Peak center. If None, defaults to 0 and is fixed.
2829
width (Int or float): Half Width at Half Maximum (HWHM)
30+
unit (str or sc.Unit): Unit of the parameters. Defaults to "meV".
2931
"""
3032

3133
def __init__(

src/easydynamics/sample_model/components/voigt.py

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,10 +25,12 @@ class Voigt(ModelComponent):
2525
Voigt profile, a convolution of Gaussian and Lorentzian.
2626
2727
Args:
28+
name (str): Name of the component.
2829
center (Int or float or None): Center of the Voigt profile.
29-
_gaussian_width (Int or float): Standard deviation of the Gaussian part.
30-
_lorentzian_width (Int or float): Half width at half max (HWHM) of the Lorentzian part.
30+
gaussian_width (Int or float): Standard deviation of the Gaussian part.
31+
lorentzian_width (Int or float): Half width at half max (HWHM) of the Lorentzian part.
3132
area (Int or float): Total area under the curve.
33+
unit (str or sc.Unit): Unit of the parameters. Defaults to "meV".
3234
"""
3335

3436
def __init__(

0 commit comments

Comments
 (0)