style: fixed docstring indent issue
All checks were successful
gitea-physics/pdme/pipeline/head This commit looks good

This commit is contained in:
Deepak Mallubhotla 2022-04-03 18:05:28 -05:00
parent d89d3585da
commit ccbb048d26
Signed by: deepak
GPG Key ID: BEBAEBF28083E022
7 changed files with 94 additions and 54 deletions

View File

@ -12,8 +12,10 @@ class DotMeasurement:
----------
v : float
The voltage measured at the dot.
r : numpy.ndarray
The position of the dot.
f : float
The measurement frequency.
"""
@ -35,10 +37,13 @@ class DotRangeMeasurement:
----------
v_low : float
The lower range of voltage measured at the dot.
v_high : float
The upper range of voltage measured at the dot.
r : numpy.ndarray
The position of the dot.
f : float
The measurement frequency.
"""

View File

@ -12,10 +12,13 @@ class DotPairMeasurement:
----------
v : float
The voltage measured at the dot.
r1 : numpy.ndarray
The position of the first dot.
r2 : numpy.ndarray
The position of the second dot.
f : float
The measurement frequency.
"""
@ -39,12 +42,16 @@ class DotPairRangeMeasurement:
----------
v_low : float
The lower range of voltage measured at the dot.
v_high : float
The upper range of voltage measured at the dot.
r1 : numpy.ndarray
The position of the first dot.
r2 : numpy.ndarray
The position of the second dot.
f : float
The measurement frequency.
"""

View File

@ -19,8 +19,10 @@ class OscillatingDipole:
----------
p : numpy.ndarray
The oscillating dipole moment, with overall sign arbitrary.
s : numpy.ndarray
The position of the dipole.
w : float
The oscillation frequency.
"""
@ -44,6 +46,7 @@ class OscillatingDipole:
----------
r : numpy.ndarray
The position of the dot.
f : float
The dot frequency to sample.
"""

View File

@ -19,6 +19,7 @@ class FixedDipoleModel(Model):
----------
p : numpy.ndarray
The fixed dipole moment.
n : int
The number of dipoles to assume.
"""
@ -123,10 +124,13 @@ class FixedDipoleDiscretisation(Discretisation):
----------
model : FixedDipoleModel
The parent model of the discretisation.
num_x : int
The number of partitions of the x axis.
num_y : int
The number of partitions of the y axis.
num_z : int
The number of partitions of the z axis.
"""

View File

@ -19,6 +19,7 @@ class FixedMagnitudeModel(Model):
----------
pfixed : float
The fixed dipole magnitude.
n : int
The number of dipoles to assume.
"""
@ -185,14 +186,19 @@ class FixedMagnitudeDiscretisation(Discretisation):
----------
model : FixedMagnitudeModel
The parent model of the discretisation.
num_ptheta: int
The number of partitions of ptheta.
num_pphi: int
The number of partitions of pphi.
num_x : int
The number of partitions of the x axis.
num_y : int
The number of partitions of the y axis.
num_z : int
The number of partitions of the z axis.
"""

View File

@ -16,14 +16,19 @@ class FixedZPlaneModel(Model):
----------
z : float
The z position of the plane where dipoles are constrained to lie.
xmin : float
The minimum x value for dipoles.
xmax : float
The maximum x value for dipoles.
ymin : float
The minimum y value for dipoles.
ymax : float
The maximum y value for dipoles.
n : int
The number of dipoles to assume.
"""
@ -104,10 +109,13 @@ class FixedZPlaneDiscretisation:
----------
model : FixedZPlaneModel
The parent model of the discretisation.
num_pz: int
The number of partitions of pz.
num_x : int
The number of partitions of the x axis.
num_y : int
The number of partitions of the y axis.
"""

View File

@ -124,18 +124,25 @@ class UnrestrictedDiscretisation(Discretisation):
----------
model : UnrestrictedModel
The parent model of the discretisation.
num_px: int
The number of partitions of the px.
num_py: int
The number of partitions of the py.
num_pz: int
The number of partitions of pz.
num_x : int
The number of partitions of the x axis.
num_y : int
The number of partitions of the y axis.
num_z : int
The number of partitions of the z axis.
max_p : int
The maximum p coordinate in any direction.
"""