correct referencing

这个提交包含在:
John Hartley
2019-08-24 12:34:46 +01:00
父节点 0b4f26d1fe
当前提交 abc1e24910
共有 3 个文件被更改,包括 12 次插入12 次删除

查看文件

@@ -11,11 +11,11 @@ import numpy as np
class AddGrass(UserObjectGeometry):
"""Allows you to add grass with roots to a :class:`FractalBox` in the model.
"""Allows you to add grass with roots to a :class:`gprMax.cmds_geometry.fractal_box.FractalBox` in the model.
:param p1: The lower left (x,y,z) coordinates of a surface on a :class:`FractalBox`
:param p1: The lower left (x,y,z) coordinates of a surface on a :class:`gprMax.cmds_geometry.fractal_box.FractalBox`
:type p1: list, non-optional
:param p2: The lower left (x,y,z) coordinates of a surface on a :class:`FractalBox`
:param p2: The lower left (x,y,z) coordinates of a surface on a :class:`gprMax.cmds_geometry.fractal_box.FractalBox`
:type p2: list, non-optional
:param frac_dim: is the fractal dimension which, for an orthogonal parallelepiped, should take values between zero and three.
:type frac_dim: float, non-optional
@@ -23,7 +23,7 @@ class AddGrass(UserObjectGeometry):
:type limits: list, non-optional
:param n_blades: The number of blades of grass that should be applied to the surface area.
:type n_blades: int, non-optional
:param fractal_box_id: An identifier for the :class:`FractalBox` that the grass should be applied to
:param fractal_box_id: An identifier for the :class:`gprMax.cmds_geometry.fractal_box.FractalBox` that the grass should be applied to
:type fractal_box_id: list, non-optional
"""

查看文件

@@ -10,11 +10,11 @@ import numpy as np
class AddSurfaceRoughness(UserObjectGeometry):
"""Allows you to add grass with roots to a :class:`FractalBox` in the model.
"""Allows you to add grass with roots to a :class:`gprMax.cmds_geometry.fractal_box.FractalBox` in the model.
:param p1: The lower left (x,y,z) coordinates of a surface on a :class:`FractalBox`
:param p1: The lower left (x,y,z) coordinates of a surface on a :class:`gprMax.cmds_geometry.fractal_box.FractalBox`
:type p1: list, non-optional
:param p2: The lower left (x,y,z) coordinates of a surface on a :class:`FractalBox`
:param p2: The lower left (x,y,z) coordinates of a surface on a :class:`gprMax.cmds_geometry.fractal_box.FractalBox`
:type p2: list, non-optional
:param frac_dim: is the fractal dimension which, for an orthogonal parallelepiped, should take values between zero and three.
:type frac_dim: float, non-optional
@@ -22,7 +22,7 @@ class AddSurfaceRoughness(UserObjectGeometry):
:type weighting: list, non-optional
:param limits: Define lower and upper limits for a range over which the roughness can vary.
:type limits: list, non-optional
:param fractal_box_id: An identifier for the :class:`FractalBox` that the roughness should be applied to
:param fractal_box_id: An identifier for the :class:`gprMax.cmds_geometry.fractal_box.FractalBox` that the roughness should be applied to
:type fractal_box_id: list, non-optional
:param seed: Is an optional parameter which controls the seeding of the random number generator used to create the fractals.
:type seed: int, optional

查看文件

@@ -8,15 +8,15 @@ from tqdm import tqdm
class AddSurfaceWater(UserObjectGeometry):
"""Allows you to add surface water to a :class:`FractalBox` in the model.
"""Allows you to add surface water to a :class:`gprMax.cmds_geometry.fractal_box.FractalBox` in the model.
:param p1: The lower left (x,y,z) coordinates of a surface on a :class:`FractalBox`
:param p1: The lower left (x,y,z) coordinates of a surface on a :class:`gprMax.cmds_geometry.fractal_box.FractalBox`
:type p1: list, non-optional
:param p2: The lower left (x,y,z) coordinates of a surface on a :class:`FractalBox`
:param p2: The lower left (x,y,z) coordinates of a surface on a :class:`gprMax.cmds_geometry.fractal_box.FractalBox`
:type p2: list, non-optional
:param depth: Defines the depth of the water, which should be specified relative to the dimensions of the #fractal_box that the surface water is being applied.
:type depth: float, non-optional
:param fractal_box_id: An identifier for the :class:`FractalBox` that the water should be applied to
:param fractal_box_id: An identifier for the :class:`gprMax.cmds_geometry.fractal_box.FractalBox` that the water should be applied to
:type fractal_box_id: list, non-optional
"""