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

@ -11,11 +11,13 @@ class DotMeasurement:
Parameters Parameters
---------- ----------
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.
""" """
v: float v: float
@ -34,13 +36,16 @@ class DotRangeMeasurement:
Parameters Parameters
---------- ----------
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.
""" """
v_low: float v_low: float

View File

@ -11,13 +11,16 @@ class DotPairMeasurement:
Parameters Parameters
---------- ----------
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.
""" """
v: float v: float
@ -38,15 +41,19 @@ class DotPairRangeMeasurement:
Parameters Parameters
---------- ----------
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.
""" """
v_low: float v_low: float

View File

@ -18,11 +18,13 @@ class OscillatingDipole:
Parameters Parameters
---------- ----------
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.
""" """
p: numpy.ndarray p: numpy.ndarray
@ -43,9 +45,10 @@ class OscillatingDipole:
Parameters Parameters
---------- ----------
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.
""" """
return (self._alpha(r)) ** 2 * self._b(f) return (self._alpha(r)) ** 2 * self._b(f)

View File

@ -18,9 +18,10 @@ class FixedDipoleModel(Model):
Parameters Parameters
---------- ----------
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.
""" """
def __init__( def __init__(
@ -122,13 +123,16 @@ class FixedDipoleDiscretisation(Discretisation):
Parameters Parameters
---------- ----------
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.
""" """
model: FixedDipoleModel model: FixedDipoleModel

View File

@ -18,9 +18,10 @@ class FixedMagnitudeModel(Model):
Parameters Parameters
---------- ----------
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.
""" """
def __init__( def __init__(
@ -184,17 +185,22 @@ class FixedMagnitudeDiscretisation(Discretisation):
Parameters Parameters
---------- ----------
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.
""" """
model: FixedMagnitudeModel model: FixedMagnitudeModel

View File

@ -15,17 +15,22 @@ class FixedZPlaneModel(Model):
Parameters Parameters
---------- ----------
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.
""" """
def __init__( def __init__(
@ -103,13 +108,16 @@ class FixedZPlaneDiscretisation:
Parameters Parameters
---------- ----------
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.
""" """
model: FixedZPlaneModel model: FixedZPlaneModel

View File

@ -18,7 +18,7 @@ class UnrestrictedModel(Model):
Parameters Parameters
---------- ----------
n : int n : int
The number of dipoles to assume. The number of dipoles to assume.
""" """
def __init__( def __init__(
@ -123,21 +123,28 @@ class UnrestrictedDiscretisation(Discretisation):
Parameters Parameters
---------- ----------
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.
""" """
model: UnrestrictedModel model: UnrestrictedModel