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
@ -11,11 +11,13 @@ class DotMeasurement:
|
||||
Parameters
|
||||
----------
|
||||
v : float
|
||||
The voltage measured at the dot.
|
||||
The voltage measured at the dot.
|
||||
|
||||
r : numpy.ndarray
|
||||
The position of the dot.
|
||||
The position of the dot.
|
||||
|
||||
f : float
|
||||
The measurement frequency.
|
||||
The measurement frequency.
|
||||
"""
|
||||
|
||||
v: float
|
||||
@ -34,13 +36,16 @@ class DotRangeMeasurement:
|
||||
Parameters
|
||||
----------
|
||||
v_low : float
|
||||
The lower range of voltage measured at the dot.
|
||||
The lower range of voltage measured at the dot.
|
||||
|
||||
v_high : float
|
||||
The upper range of voltage measured at the dot.
|
||||
The upper range of voltage measured at the dot.
|
||||
|
||||
r : numpy.ndarray
|
||||
The position of the dot.
|
||||
The position of the dot.
|
||||
|
||||
f : float
|
||||
The measurement frequency.
|
||||
The measurement frequency.
|
||||
"""
|
||||
|
||||
v_low: float
|
||||
|
@ -11,13 +11,16 @@ class DotPairMeasurement:
|
||||
Parameters
|
||||
----------
|
||||
v : float
|
||||
The voltage measured at the dot.
|
||||
The voltage measured at the dot.
|
||||
|
||||
r1 : numpy.ndarray
|
||||
The position of the first dot.
|
||||
The position of the first dot.
|
||||
|
||||
r2 : numpy.ndarray
|
||||
The position of the second dot.
|
||||
The position of the second dot.
|
||||
|
||||
f : float
|
||||
The measurement frequency.
|
||||
The measurement frequency.
|
||||
"""
|
||||
|
||||
v: float
|
||||
@ -38,15 +41,19 @@ class DotPairRangeMeasurement:
|
||||
Parameters
|
||||
----------
|
||||
v_low : float
|
||||
The lower range of voltage measured at the dot.
|
||||
The lower range of voltage measured at the dot.
|
||||
|
||||
v_high : float
|
||||
The upper range of voltage measured at the dot.
|
||||
The upper range of voltage measured at the dot.
|
||||
|
||||
r1 : numpy.ndarray
|
||||
The position of the first dot.
|
||||
The position of the first dot.
|
||||
|
||||
r2 : numpy.ndarray
|
||||
The position of the second dot.
|
||||
The position of the second dot.
|
||||
|
||||
f : float
|
||||
The measurement frequency.
|
||||
The measurement frequency.
|
||||
"""
|
||||
|
||||
v_low: float
|
||||
|
@ -18,11 +18,13 @@ class OscillatingDipole:
|
||||
Parameters
|
||||
----------
|
||||
p : numpy.ndarray
|
||||
The oscillating dipole moment, with overall sign arbitrary.
|
||||
The oscillating dipole moment, with overall sign arbitrary.
|
||||
|
||||
s : numpy.ndarray
|
||||
The position of the dipole.
|
||||
The position of the dipole.
|
||||
|
||||
w : float
|
||||
The oscillation frequency.
|
||||
The oscillation frequency.
|
||||
"""
|
||||
|
||||
p: numpy.ndarray
|
||||
@ -43,9 +45,10 @@ class OscillatingDipole:
|
||||
Parameters
|
||||
----------
|
||||
r : numpy.ndarray
|
||||
The position of the dot.
|
||||
The position of the dot.
|
||||
|
||||
f : float
|
||||
The dot frequency to sample.
|
||||
The dot frequency to sample.
|
||||
"""
|
||||
return (self._alpha(r)) ** 2 * self._b(f)
|
||||
|
||||
|
@ -18,9 +18,10 @@ class FixedDipoleModel(Model):
|
||||
Parameters
|
||||
----------
|
||||
p : numpy.ndarray
|
||||
The fixed dipole moment.
|
||||
The fixed dipole moment.
|
||||
|
||||
n : int
|
||||
The number of dipoles to assume.
|
||||
The number of dipoles to assume.
|
||||
"""
|
||||
|
||||
def __init__(
|
||||
@ -122,13 +123,16 @@ class FixedDipoleDiscretisation(Discretisation):
|
||||
Parameters
|
||||
----------
|
||||
model : FixedDipoleModel
|
||||
The parent model of the discretisation.
|
||||
The parent model of the discretisation.
|
||||
|
||||
num_x : int
|
||||
The number of partitions of the x axis.
|
||||
The number of partitions of the x axis.
|
||||
|
||||
num_y : int
|
||||
The number of partitions of the y axis.
|
||||
The number of partitions of the y axis.
|
||||
|
||||
num_z : int
|
||||
The number of partitions of the z axis.
|
||||
The number of partitions of the z axis.
|
||||
"""
|
||||
|
||||
model: FixedDipoleModel
|
||||
|
@ -18,9 +18,10 @@ class FixedMagnitudeModel(Model):
|
||||
Parameters
|
||||
----------
|
||||
pfixed : float
|
||||
The fixed dipole magnitude.
|
||||
The fixed dipole magnitude.
|
||||
|
||||
n : int
|
||||
The number of dipoles to assume.
|
||||
The number of dipoles to assume.
|
||||
"""
|
||||
|
||||
def __init__(
|
||||
@ -184,17 +185,22 @@ class FixedMagnitudeDiscretisation(Discretisation):
|
||||
Parameters
|
||||
----------
|
||||
model : FixedMagnitudeModel
|
||||
The parent model of the discretisation.
|
||||
The parent model of the discretisation.
|
||||
|
||||
num_ptheta: int
|
||||
The number of partitions of ptheta.
|
||||
The number of partitions of ptheta.
|
||||
|
||||
num_pphi: int
|
||||
The number of partitions of pphi.
|
||||
The number of partitions of pphi.
|
||||
|
||||
num_x : int
|
||||
The number of partitions of the x axis.
|
||||
The number of partitions of the x axis.
|
||||
|
||||
num_y : int
|
||||
The number of partitions of the y axis.
|
||||
The number of partitions of the y axis.
|
||||
|
||||
num_z : int
|
||||
The number of partitions of the z axis.
|
||||
The number of partitions of the z axis.
|
||||
"""
|
||||
|
||||
model: FixedMagnitudeModel
|
||||
|
@ -15,17 +15,22 @@ class FixedZPlaneModel(Model):
|
||||
Parameters
|
||||
----------
|
||||
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
|
||||
The minimum x value for dipoles.
|
||||
The minimum x value for dipoles.
|
||||
|
||||
xmax : float
|
||||
The maximum x value for dipoles.
|
||||
The maximum x value for dipoles.
|
||||
|
||||
ymin : float
|
||||
The minimum y value for dipoles.
|
||||
The minimum y value for dipoles.
|
||||
|
||||
ymax : float
|
||||
The maximum y value for dipoles.
|
||||
The maximum y value for dipoles.
|
||||
|
||||
n : int
|
||||
The number of dipoles to assume.
|
||||
The number of dipoles to assume.
|
||||
"""
|
||||
|
||||
def __init__(
|
||||
@ -103,13 +108,16 @@ class FixedZPlaneDiscretisation:
|
||||
Parameters
|
||||
----------
|
||||
model : FixedZPlaneModel
|
||||
The parent model of the discretisation.
|
||||
The parent model of the discretisation.
|
||||
|
||||
num_pz: int
|
||||
The number of partitions of pz.
|
||||
The number of partitions of pz.
|
||||
|
||||
num_x : int
|
||||
The number of partitions of the x axis.
|
||||
The number of partitions of the x axis.
|
||||
|
||||
num_y : int
|
||||
The number of partitions of the y axis.
|
||||
The number of partitions of the y axis.
|
||||
"""
|
||||
|
||||
model: FixedZPlaneModel
|
||||
|
@ -18,7 +18,7 @@ class UnrestrictedModel(Model):
|
||||
Parameters
|
||||
----------
|
||||
n : int
|
||||
The number of dipoles to assume.
|
||||
The number of dipoles to assume.
|
||||
"""
|
||||
|
||||
def __init__(
|
||||
@ -123,21 +123,28 @@ class UnrestrictedDiscretisation(Discretisation):
|
||||
Parameters
|
||||
----------
|
||||
model : UnrestrictedModel
|
||||
The parent model of the discretisation.
|
||||
The parent model of the discretisation.
|
||||
|
||||
num_px: int
|
||||
The number of partitions of the px.
|
||||
The number of partitions of the px.
|
||||
|
||||
num_py: int
|
||||
The number of partitions of the py.
|
||||
The number of partitions of the py.
|
||||
|
||||
num_pz: int
|
||||
The number of partitions of pz.
|
||||
The number of partitions of pz.
|
||||
|
||||
num_x : int
|
||||
The number of partitions of the x axis.
|
||||
The number of partitions of the x axis.
|
||||
|
||||
num_y : int
|
||||
The number of partitions of the y axis.
|
||||
The number of partitions of the y axis.
|
||||
|
||||
num_z : int
|
||||
The number of partitions of the z axis.
|
||||
The number of partitions of the z axis.
|
||||
|
||||
max_p : int
|
||||
The maximum p coordinate in any direction.
|
||||
The maximum p coordinate in any direction.
|
||||
"""
|
||||
|
||||
model: UnrestrictedModel
|
||||
|
Loading…
x
Reference in New Issue
Block a user