Note: The default ITS GitLab runner is a shared resource and is subject to slowdowns during heavy usage.
You can run your own GitLab runner that is dedicated just to your group if you need to avoid processing delays.

Commit 4e43f9d5 authored by Camilla Dodge Koslowsky Harris's avatar Camilla Dodge Koslowsky Harris
Browse files

Attempting to make it clearer which kwargs are required for which geometries

parent 97a791e3
...@@ -734,33 +734,33 @@ Returns a tecplot zone object. ...@@ -734,33 +734,33 @@ Returns a tecplot zone object.
False. False.
- `**center` _array-like_ - Argument for the `shell` geometry. Contains the - `**center` _array-like_ - Argument for the `shell` geometry. Contains the
X, Y, and Z positions of the shell. Defaults to (0,0,0). X, Y, and Z positions of the shell. Defaults to (0,0,0).
- `**radius` _float_ - Argument for the `shell` geometry. Required. - `**radius` _float_ - Required argument for the `shell` geometry.
- `**npoints` _array-like_ - Argument for the `shell` geometry. Contains the - `**npoints` _array-like_ - Argument for the `shell` geometry. Contains the
number of points in the azimuthal and polar directions to interpolate number of points in the azimuthal and polar directions to interpolate
onto, excluding the north and south polar points. Defaults to onto, excluding the north and south polar points. Defaults to
(360, 179). (360, 179).
- `**r1` _array-like_ - Argument for the `line` geometry. Contains the X, Y, - `**r1` _array-like_ - Required argument for the `line` geometry. Contains
and Z positions of the point where the line starts. Required. the X, Y, and Z positions of the point where the line starts.
- `**r2` _array-like_ - Argument for the `line` geometry. Contains the X, Y, - `**r2` _array-like_ - Required argument for the `line` geometry. Contains
and Z positions of the point where the line ends. Required. the X, Y, and Z positions of the point where the line ends.
- `**npoints` _int_ - Argument for the `line` geometry. The number of points - `**npoints` _int_ - Required argument for the `line` geometry. The number
along the line to interpolate onto. Required. of points along the line to interpolate onto.
- `**center` _array-like_ - Argument for the `rectprism` geometry. Contains - `**center` _array-like_ - Argument for the `rectprism` geometry. Contains
the X, Y, and Z positions of the center of the rectangular prism. the X, Y, and Z positions of the center of the rectangular prism.
Defaults to (0,0,0). Defaults to (0,0,0).
- `**halfwidths` _array-like_ - Argument for the `rectprism` geometry. - `**halfwidths` _array-like_ - Required argument for the `rectprism`
Contains the half widths of the rectangular prism in the X, Y, and Z geometry. Contains the half widths of the rectangular prism in the X,
directions. Required. Y, and Z directions.
- `**npoints` _array-like_ - Argument for the `rectprism` geometry. Contains - `**npoints` _array-like_ - Required argument for the `rectprism` geometry.
the number of points in the X, Y, and Z directions to interpolate Contains the number of points in the X, Y, and Z directions to
onto. Required. interpolate onto.
- `**trajectory_data` _str_ - Argument for the `trajectory` geometry. The - `**trajectory_data` _str_ - Required argument for the `trajectory`
path to the ASCII trajectory data file. Required. geometry. The path to the ASCII trajectory data file.
- `**trajectory_format` _str_ - Argument for the `trajectory` geometry. The - `**trajectory_format` _str_ - Required argument for the `trajectory`
format of the trajectory data file. Supported formats are `tecplot` geometry. The format of the trajectory data file. Supported formats
(data is a tecplot zone with 3D positional variables) and `batsrus` are `tecplot` (data is a tecplot zone with 3D positional variables)
(data is formatted as described for the ``SATELLITE`` command, see SWMF and `batsrus` (data is formatted as described for the `SATELLITE`
documentation). Required. command, see SWMF documentation).
**Examples**: **Examples**:
...@@ -807,7 +807,7 @@ Returns a tecplot zone object. ...@@ -807,7 +807,7 @@ Returns a tecplot zone object.
) )
## geometry: spacecraft trajectory as specified for the ## geometry: spacecraft trajectory as specified for the
## BATSRUS `SATELLITE` command ## BATSRUS SATELLITE command
tpt.interpolate_zone_to_geometry( tpt.interpolate_zone_to_geometry(
dataset=dataset, dataset=dataset,
source_zone=dataset.zone(0), source_zone=dataset.zone(0),
......
...@@ -110,7 +110,7 @@ def _rectprism_geometry(geometry_params: dict) -> dict: ...@@ -110,7 +110,7 @@ def _rectprism_geometry(geometry_params: dict) -> dict:
def _trajectory_geometry(geometry_params: dict) -> dict: def _trajectory_geometry(geometry_params: dict) -> dict:
"""Returns a dict containing points for the described trajectory geometry. """Returns a dict containing points for the described trajectory geometry.
Assumes format of trajectory file after SWMF SATELLITE command. Assumes format of trajectory file after SWMF `SATELLITE` command.
""" """
do_read = False do_read = False
trajectory_data = [] trajectory_data = []
...@@ -483,33 +483,33 @@ def interpolate_zone_to_geometry( ...@@ -483,33 +483,33 @@ def interpolate_zone_to_geometry(
False. False.
**center (array-like): Argument for the `shell` geometry. Contains the **center (array-like): Argument for the `shell` geometry. Contains the
X, Y, and Z positions of the shell. Defaults to (0,0,0). X, Y, and Z positions of the shell. Defaults to (0,0,0).
**radius (float): Argument for the `shell` geometry. Required. **radius (float): Required argument for the `shell` geometry.
**npoints (array-like): Argument for the `shell` geometry. Contains the **npoints (array-like): Argument for the `shell` geometry. Contains the
number of points in the azimuthal and polar directions to interpolate number of points in the azimuthal and polar directions to interpolate
onto, excluding the north and south polar points. Defaults to onto, excluding the north and south polar points. Defaults to
(360, 179). (360, 179).
**r1 (array-like): Argument for the `line` geometry. Contains the X, Y, **r1 (array-like): Required argument for the `line` geometry. Contains
and Z positions of the point where the line starts. Required. the X, Y, and Z positions of the point where the line starts.
**r2 (array-like): Argument for the `line` geometry. Contains the X, Y, **r2 (array-like): Required argument for the `line` geometry. Contains
and Z positions of the point where the line ends. Required. the X, Y, and Z positions of the point where the line ends.
**npoints (int): Argument for the `line` geometry. The number of points **npoints (int): Required argument for the `line` geometry. The number
along the line to interpolate onto. Required. of points along the line to interpolate onto.
**center (array-like): Argument for the `rectprism` geometry. Contains **center (array-like): Argument for the `rectprism` geometry. Contains
the X, Y, and Z positions of the center of the rectangular prism. the X, Y, and Z positions of the center of the rectangular prism.
Defaults to (0,0,0). Defaults to (0,0,0).
**halfwidths (array-like): Argument for the `rectprism` geometry. **halfwidths (array-like): Required argument for the `rectprism`
Contains the half widths of the rectangular prism in the X, Y, and Z geometry. Contains the half widths of the rectangular prism in the X,
directions. Required. Y, and Z directions.
**npoints (array-like): Argument for the `rectprism` geometry. Contains **npoints (array-like): Required argument for the `rectprism` geometry.
the number of points in the X, Y, and Z directions to interpolate Contains the number of points in the X, Y, and Z directions to
onto. Required. interpolate onto.
**trajectory_data (str): Argument for the `trajectory` geometry. The **trajectory_data (str): Required argument for the `trajectory`
path to the ASCII trajectory data file. Required. geometry. The path to the ASCII trajectory data file.
**trajectory_format (str): Argument for the `trajectory` geometry. The **trajectory_format (str): Required argument for the `trajectory`
format of the trajectory data file. Supported formats are `tecplot` geometry. The format of the trajectory data file. Supported formats
(data is a tecplot zone with 3D positional variables) and `batsrus` are `tecplot` (data is a tecplot zone with 3D positional variables)
(data is formatted as described for the `#SATELLITE` command, see SWMF and `batsrus` (data is formatted as described for the `SATELLITE`
documentation). Required. command, see SWMF documentation).
Examples: Examples:
```python ```python
...@@ -554,7 +554,7 @@ def interpolate_zone_to_geometry( ...@@ -554,7 +554,7 @@ def interpolate_zone_to_geometry(
) )
## geometry: spacecraft trajectory as specified for the ## geometry: spacecraft trajectory as specified for the
## BATSRUS #SATELLITE command ## BATSRUS SATELLITE command
tpt.interpolate_zone_to_geometry( tpt.interpolate_zone_to_geometry(
dataset=dataset, dataset=dataset,
source_zone=dataset.zone(0), source_zone=dataset.zone(0),
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment