style: fixed docstring indent issue
All checks were successful
gitea-physics/pdme/pipeline/head This commit looks good
All checks were successful
gitea-physics/pdme/pipeline/head This commit looks good
This commit is contained in:
parent
d89d3585da
commit
ccbb048d26
@ -12,8 +12,10 @@ class DotMeasurement:
|
|||||||
----------
|
----------
|
||||||
v : float
|
v : float
|
||||||
The voltage measured at the dot.
|
The voltage measured at the dot.
|
||||||
|
|
||||||
r : numpy.ndarray
|
r : numpy.ndarray
|
||||||
The position of the dot.
|
The position of the dot.
|
||||||
|
|
||||||
f : float
|
f : float
|
||||||
The measurement frequency.
|
The measurement frequency.
|
||||||
"""
|
"""
|
||||||
@ -35,10 +37,13 @@ class DotRangeMeasurement:
|
|||||||
----------
|
----------
|
||||||
v_low : float
|
v_low : float
|
||||||
The lower range of voltage measured at the dot.
|
The lower range of voltage measured at the dot.
|
||||||
|
|
||||||
v_high : float
|
v_high : float
|
||||||
The upper range of voltage measured at the dot.
|
The upper range of voltage measured at the dot.
|
||||||
|
|
||||||
r : numpy.ndarray
|
r : numpy.ndarray
|
||||||
The position of the dot.
|
The position of the dot.
|
||||||
|
|
||||||
f : float
|
f : float
|
||||||
The measurement frequency.
|
The measurement frequency.
|
||||||
"""
|
"""
|
||||||
|
@ -12,10 +12,13 @@ class DotPairMeasurement:
|
|||||||
----------
|
----------
|
||||||
v : float
|
v : float
|
||||||
The voltage measured at the dot.
|
The voltage measured at the dot.
|
||||||
|
|
||||||
r1 : numpy.ndarray
|
r1 : numpy.ndarray
|
||||||
The position of the first dot.
|
The position of the first dot.
|
||||||
|
|
||||||
r2 : numpy.ndarray
|
r2 : numpy.ndarray
|
||||||
The position of the second dot.
|
The position of the second dot.
|
||||||
|
|
||||||
f : float
|
f : float
|
||||||
The measurement frequency.
|
The measurement frequency.
|
||||||
"""
|
"""
|
||||||
@ -39,12 +42,16 @@ class DotPairRangeMeasurement:
|
|||||||
----------
|
----------
|
||||||
v_low : float
|
v_low : float
|
||||||
The lower range of voltage measured at the dot.
|
The lower range of voltage measured at the dot.
|
||||||
|
|
||||||
v_high : float
|
v_high : float
|
||||||
The upper range of voltage measured at the dot.
|
The upper range of voltage measured at the dot.
|
||||||
|
|
||||||
r1 : numpy.ndarray
|
r1 : numpy.ndarray
|
||||||
The position of the first dot.
|
The position of the first dot.
|
||||||
|
|
||||||
r2 : numpy.ndarray
|
r2 : numpy.ndarray
|
||||||
The position of the second dot.
|
The position of the second dot.
|
||||||
|
|
||||||
f : float
|
f : float
|
||||||
The measurement frequency.
|
The measurement frequency.
|
||||||
"""
|
"""
|
||||||
|
@ -19,8 +19,10 @@ class OscillatingDipole:
|
|||||||
----------
|
----------
|
||||||
p : numpy.ndarray
|
p : numpy.ndarray
|
||||||
The oscillating dipole moment, with overall sign arbitrary.
|
The oscillating dipole moment, with overall sign arbitrary.
|
||||||
|
|
||||||
s : numpy.ndarray
|
s : numpy.ndarray
|
||||||
The position of the dipole.
|
The position of the dipole.
|
||||||
|
|
||||||
w : float
|
w : float
|
||||||
The oscillation frequency.
|
The oscillation frequency.
|
||||||
"""
|
"""
|
||||||
@ -44,6 +46,7 @@ class OscillatingDipole:
|
|||||||
----------
|
----------
|
||||||
r : numpy.ndarray
|
r : numpy.ndarray
|
||||||
The position of the dot.
|
The position of the dot.
|
||||||
|
|
||||||
f : float
|
f : float
|
||||||
The dot frequency to sample.
|
The dot frequency to sample.
|
||||||
"""
|
"""
|
||||||
|
@ -19,6 +19,7 @@ class FixedDipoleModel(Model):
|
|||||||
----------
|
----------
|
||||||
p : numpy.ndarray
|
p : numpy.ndarray
|
||||||
The fixed dipole moment.
|
The fixed dipole moment.
|
||||||
|
|
||||||
n : int
|
n : int
|
||||||
The number of dipoles to assume.
|
The number of dipoles to assume.
|
||||||
"""
|
"""
|
||||||
@ -123,10 +124,13 @@ class FixedDipoleDiscretisation(Discretisation):
|
|||||||
----------
|
----------
|
||||||
model : FixedDipoleModel
|
model : FixedDipoleModel
|
||||||
The parent model of the discretisation.
|
The parent model of the discretisation.
|
||||||
|
|
||||||
num_x : int
|
num_x : int
|
||||||
The number of partitions of the x axis.
|
The number of partitions of the x axis.
|
||||||
|
|
||||||
num_y : int
|
num_y : int
|
||||||
The number of partitions of the y axis.
|
The number of partitions of the y axis.
|
||||||
|
|
||||||
num_z : int
|
num_z : int
|
||||||
The number of partitions of the z axis.
|
The number of partitions of the z axis.
|
||||||
"""
|
"""
|
||||||
|
@ -19,6 +19,7 @@ class FixedMagnitudeModel(Model):
|
|||||||
----------
|
----------
|
||||||
pfixed : float
|
pfixed : float
|
||||||
The fixed dipole magnitude.
|
The fixed dipole magnitude.
|
||||||
|
|
||||||
n : int
|
n : int
|
||||||
The number of dipoles to assume.
|
The number of dipoles to assume.
|
||||||
"""
|
"""
|
||||||
@ -185,14 +186,19 @@ class FixedMagnitudeDiscretisation(Discretisation):
|
|||||||
----------
|
----------
|
||||||
model : FixedMagnitudeModel
|
model : FixedMagnitudeModel
|
||||||
The parent model of the discretisation.
|
The parent model of the discretisation.
|
||||||
|
|
||||||
num_ptheta: int
|
num_ptheta: int
|
||||||
The number of partitions of ptheta.
|
The number of partitions of ptheta.
|
||||||
|
|
||||||
num_pphi: int
|
num_pphi: int
|
||||||
The number of partitions of pphi.
|
The number of partitions of pphi.
|
||||||
|
|
||||||
num_x : int
|
num_x : int
|
||||||
The number of partitions of the x axis.
|
The number of partitions of the x axis.
|
||||||
|
|
||||||
num_y : int
|
num_y : int
|
||||||
The number of partitions of the y axis.
|
The number of partitions of the y axis.
|
||||||
|
|
||||||
num_z : int
|
num_z : int
|
||||||
The number of partitions of the z axis.
|
The number of partitions of the z axis.
|
||||||
"""
|
"""
|
||||||
|
@ -16,14 +16,19 @@ class FixedZPlaneModel(Model):
|
|||||||
----------
|
----------
|
||||||
z : float
|
z : float
|
||||||
The z position of the plane where dipoles are constrained to lie.
|
The z position of the plane where dipoles are constrained to lie.
|
||||||
|
|
||||||
xmin : float
|
xmin : float
|
||||||
The minimum x value for dipoles.
|
The minimum x value for dipoles.
|
||||||
|
|
||||||
xmax : float
|
xmax : float
|
||||||
The maximum x value for dipoles.
|
The maximum x value for dipoles.
|
||||||
|
|
||||||
ymin : float
|
ymin : float
|
||||||
The minimum y value for dipoles.
|
The minimum y value for dipoles.
|
||||||
|
|
||||||
ymax : float
|
ymax : float
|
||||||
The maximum y value for dipoles.
|
The maximum y value for dipoles.
|
||||||
|
|
||||||
n : int
|
n : int
|
||||||
The number of dipoles to assume.
|
The number of dipoles to assume.
|
||||||
"""
|
"""
|
||||||
@ -104,10 +109,13 @@ class FixedZPlaneDiscretisation:
|
|||||||
----------
|
----------
|
||||||
model : FixedZPlaneModel
|
model : FixedZPlaneModel
|
||||||
The parent model of the discretisation.
|
The parent model of the discretisation.
|
||||||
|
|
||||||
num_pz: int
|
num_pz: int
|
||||||
The number of partitions of pz.
|
The number of partitions of pz.
|
||||||
|
|
||||||
num_x : int
|
num_x : int
|
||||||
The number of partitions of the x axis.
|
The number of partitions of the x axis.
|
||||||
|
|
||||||
num_y : int
|
num_y : int
|
||||||
The number of partitions of the y axis.
|
The number of partitions of the y axis.
|
||||||
"""
|
"""
|
||||||
|
@ -124,18 +124,25 @@ class UnrestrictedDiscretisation(Discretisation):
|
|||||||
----------
|
----------
|
||||||
model : UnrestrictedModel
|
model : UnrestrictedModel
|
||||||
The parent model of the discretisation.
|
The parent model of the discretisation.
|
||||||
|
|
||||||
num_px: int
|
num_px: int
|
||||||
The number of partitions of the px.
|
The number of partitions of the px.
|
||||||
|
|
||||||
num_py: int
|
num_py: int
|
||||||
The number of partitions of the py.
|
The number of partitions of the py.
|
||||||
|
|
||||||
num_pz: int
|
num_pz: int
|
||||||
The number of partitions of pz.
|
The number of partitions of pz.
|
||||||
|
|
||||||
num_x : int
|
num_x : int
|
||||||
The number of partitions of the x axis.
|
The number of partitions of the x axis.
|
||||||
|
|
||||||
num_y : int
|
num_y : int
|
||||||
The number of partitions of the y axis.
|
The number of partitions of the y axis.
|
||||||
|
|
||||||
num_z : int
|
num_z : int
|
||||||
The number of partitions of the z axis.
|
The number of partitions of the z axis.
|
||||||
|
|
||||||
max_p : int
|
max_p : int
|
||||||
The maximum p coordinate in any direction.
|
The maximum p coordinate in any direction.
|
||||||
"""
|
"""
|
||||||
|
Loading…
x
Reference in New Issue
Block a user