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 3937b3bf authored by Camilla Dodge Koslowsky Harris's avatar Camilla Dodge Koslowsky Harris
Browse files

Figured out how I think keyword ards are supposed to be represented

parent 8e5b81b0
...@@ -669,9 +669,8 @@ Writes a tecplot zone to various formats. ...@@ -669,9 +669,8 @@ Writes a tecplot zone to various formats.
`csv`, `tecplot_ascii`, and `tecplot_plt`. `csv`, `tecplot_ascii`, and `tecplot_plt`.
- `filename` _str_ - Name of the file to write to. - `filename` _str_ - Name of the file to write to.
variables : (Optional) Specify a subset of the dataset variables to variables : (Optional) Specify a subset of the dataset variables to
save. This option may decrease the size of the save. This option may decrease the size of the output. Default
output. Default behavior is to save all behavior is to save all variables.
variables.
- `verbose` - (Optional) Print diagnostic information. Defaults to False. - `verbose` - (Optional) Print diagnostic information. Defaults to False.
...@@ -724,49 +723,41 @@ Interpolates Tecplot binary data onto various geometries. ...@@ -724,49 +723,41 @@ Interpolates Tecplot binary data onto various geometries.
- `dataset` - The loaded Tecplot dataset. - `dataset` - The loaded Tecplot dataset.
- `source_zone` - The Tecplot zone to interpolate onto the geometry. - `source_zone` - The Tecplot zone to interpolate onto the geometry.
- `geometry` _str_ - Type of geometry for interpolation. Supported geometries - `geometry` _str_ - Type of geometry for interpolation. Supported geometries
are `shell`, `line`, `rectprism`, or `trajectory`. See are `shell`, `line`, `rectprism`, or `trajectory`. See below for the
below for the required keyword arguments for each required keyword arguments for each geometry.
geometry.
- `variables` _list_ - (Optional) Subset of variables to interpolate. Default - `variables` _list_ - (Optional) Subset of variables to interpolate. Default
behavior is to interpolate all variables. behavior is to interpolate all variables.
- `verbose` - (Optional) Print diagnostic information. Defaults to False. - `verbose` _bool_ - (Optional) Print diagnostic information. Defaults to
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 X, Y, and Z positions of the shell. Defaults to (0,0,0).
(0,0,0). - `**radius` _float_ - Argument for the `shell` geometry. Required.
- `**npoints` _array-like_ - Argument for the `shell` geometry. Contains the
**kwargs: number of points in the azimuthal and polar directions to interpolate
- `radius` _float_ - Argument for the `shell` geometry. Required. onto, excluding the north and south polar points. Defaults to
- `npoints` _array-like_ - Argument for the `shell` geometry. Contains the (360, 179).
number of points in the azimuthal and polar - `**r1` _array-like_ - Argument for the `line` geometry. Contains the X, Y,
directions to interpolate onto, excluding the and Z positions of the point where the line starts. Required.
north and south polar points. Defaults to - `**r2` _array-like_ - Argument for the `line` geometry. Contains the X, Y,
(360,179). and Z positions of the point where the line ends. Required.
- `r1` _array-like_ - Argument for the `line` geometry. Contains the X, Y, - `**npoints` _int_ - Argument for the `line` geometry. The number of points
and Z positions of the point where the line starts.
Required.
- `r2` _array-like_ - Argument for the `line` geometry. Contains the X, Y,
and Z positions of the point where the line ends.
Required.
- `npoints` _int_ - Argument for the `line` geometry. The number of points
along the line to interpolate onto. Required. along the line to interpolate onto. Required.
- `center` _array-like_ - Argument for the `rectprism` geometry. Contains the - `**center` _array-like_ - Argument for the `rectprism` geometry. Contains
X, Y, and Z positions of the center of the the X, Y, and Z positions of the center of the rectangular prism.
rectangular prism. Defaults to (0,0,0). Defaults to (0,0,0).
- `halfwidths` _array-like_ - Argument for the `rectprism` geometry. Contains - `**halfwidths` _array-like_ - Argument for the `rectprism` geometry.
the half widths of the rectangular prism in the Contains the half widths of the rectangular prism in the X, Y, and Z
X, Y, and Z directions. Required. directions. Required.
- `npoints` _array-like_ - Argument for the `rectprism` geometry. Contains - `**npoints` _array-like_ - Argument for the `rectprism` geometry. Contains
the number of points in the X, Y, and Z directions the number of points in the X, Y, and Z directions to interpolate
to interpolate onto. Required. onto. Required.
- `trajectory_data` _str_ - Argument for the `trajectory` geometry. The path - `**trajectory_data` _str_ - Argument for the `trajectory` geometry. The
to the ASCII trajectory data file. Required. path to the ASCII trajectory data file. Required.
- `trajectory_format` _str_ - Argument for the `trajectory` geometry. The - `**trajectory_format` _str_ - Argument for the `trajectory` geometry. The
format of the trajectory data file. Supported format of the trajectory data file. Supported formats are `tecplot`
formats are `tecplot` (data is a tecplot zone (data is a tecplot zone with 3D positional variables) and `batsrus`
with 3D positional variables) and `batsrus` (data is formatted as described for the ``SATELLITE`` command, see SWMF
(data is formatted as described for the documentation). Required.
``SATELLITE`` command, see SWMF documentation).
Required.
**Examples**: **Examples**:
......
...@@ -201,9 +201,9 @@ def apply_equations(eqn_path: str, verbose: bool = False) -> None: ...@@ -201,9 +201,9 @@ def apply_equations(eqn_path: str, verbose: bool = False) -> None:
Args: Args:
eqn_file_path (str): The path to the equation macro file (typically with eqn_file_path (str): The path to the equation macro file (typically with
extension `.eqn`). extension `.eqn`).
verbose (bool): (Optional) Whether or not to print the equations as they verbose (bool): (Optional) Whether or not to print the equations as they
are applied. Default behavior is silent. are applied. Default behavior is silent.
Examples: Examples:
```python ```python
...@@ -260,7 +260,7 @@ def bracketify(variable_name: str) -> str: ...@@ -260,7 +260,7 @@ def bracketify(variable_name: str) -> str:
Args: Args:
variable_name (str): A string which may contain the meta-characters * ? variable_name (str): A string which may contain the meta-characters * ?
[ or ]. [ or ].
Examples: Examples:
In a dataset which contains the variable 'X [R]', In a dataset which contains the variable 'X [R]',
...@@ -304,12 +304,11 @@ def write_zone( ...@@ -304,12 +304,11 @@ def write_zone(
tecplot_dataset (tecplot.data.dataset.Dataset): The dataset to save. tecplot_dataset (tecplot.data.dataset.Dataset): The dataset to save.
tecplot_zone (tecplot.data.dataset.Zone): The zone to save. tecplot_zone (tecplot.data.dataset.Zone): The zone to save.
write_as (str): Type of file to write to. Supported options are `hdf5`, write_as (str): Type of file to write to. Supported options are `hdf5`,
`csv`, `tecplot_ascii`, and `tecplot_plt`. `csv`, `tecplot_ascii`, and `tecplot_plt`.
filename (str): Name of the file to write to. filename (str): Name of the file to write to.
variables : (Optional) Specify a subset of the dataset variables to variables : (Optional) Specify a subset of the dataset variables to
save. This option may decrease the size of the save. This option may decrease the size of the output. Default
output. Default behavior is to save all behavior is to save all variables.
variables.
verbose: (Optional) Print diagnostic information. Defaults to False. verbose: (Optional) Print diagnostic information. Defaults to False.
Examples: Examples:
...@@ -404,7 +403,7 @@ def _assign_geometry_defaults( ...@@ -404,7 +403,7 @@ def _assign_geometry_defaults(
geometry (str): String identifying the geometry to look for. geometry (str): String identifying the geometry to look for.
default_params (dict): Dictionary of the default parameters. default_params (dict): Dictionary of the default parameters.
geomatry_params (dict): Dictionary in which to look for and set geomatry_params (dict): Dictionary in which to look for and set
parameters. parameters.
""" """
if geometry in geometry_params['geometry']: if geometry in geometry_params['geometry']:
for key, value in default_params.items(): for key, value in default_params.items():
...@@ -463,49 +462,41 @@ def interpolate_zone_to_geometry( ...@@ -463,49 +462,41 @@ def interpolate_zone_to_geometry(
dataset: The loaded Tecplot dataset. dataset: The loaded Tecplot dataset.
source_zone: The Tecplot zone to interpolate onto the geometry. source_zone: The Tecplot zone to interpolate onto the geometry.
geometry (str): Type of geometry for interpolation. Supported geometries geometry (str): Type of geometry for interpolation. Supported geometries
are `shell`, `line`, `rectprism`, or `trajectory`. See are `shell`, `line`, `rectprism`, or `trajectory`. See below for the
below for the required keyword arguments for each required keyword arguments for each geometry.
geometry.
variables (list): (Optional) Subset of variables to interpolate. Default variables (list): (Optional) Subset of variables to interpolate. Default
behavior is to interpolate all variables. behavior is to interpolate all variables.
verbose: (Optional) Print diagnostic information. Defaults to False. verbose (bool): (Optional) Print diagnostic information. Defaults to
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 X, Y, and Z positions of the shell. Defaults to (0,0,0).
(0,0,0). **radius (float): Argument for the `shell` geometry. Required.
**npoints (array-like): Argument for the `shell` geometry. Contains the
**kwargs: number of points in the azimuthal and polar directions to interpolate
radius (float): Argument for the `shell` geometry. Required. onto, excluding the north and south polar points. Defaults to
npoints (array-like): Argument for the `shell` geometry. Contains the (360, 179).
number of points in the azimuthal and polar **r1 (array-like): Argument for the `line` geometry. Contains the X, Y,
directions to interpolate onto, excluding the and Z positions of the point where the line starts. Required.
north and south polar points. Defaults to **r2 (array-like): Argument for the `line` geometry. Contains the X, Y,
(360,179). and Z positions of the point where the line ends. Required.
r1 (array-like): Argument for the `line` geometry. Contains the X, Y, **npoints (int): Argument for the `line` geometry. The number of points
and Z positions of the point where the line starts. along the line to interpolate onto. Required.
Required. **center (array-like): Argument for the `rectprism` geometry. Contains
r2 (array-like): Argument for the `line` geometry. Contains the X, Y, the X, Y, and Z positions of the center of the rectangular prism.
and Z positions of the point where the line ends. Defaults to (0,0,0).
Required. **halfwidths (array-like): Argument for the `rectprism` geometry.
npoints (int): Argument for the `line` geometry. The number of points Contains the half widths of the rectangular prism in the X, Y, and Z
along the line to interpolate onto. Required. directions. Required.
center (array-like): Argument for the `rectprism` geometry. Contains the **npoints (array-like): Argument for the `rectprism` geometry. Contains
X, Y, and Z positions of the center of the the number of points in the X, Y, and Z directions to interpolate
rectangular prism. Defaults to (0,0,0). onto. Required.
halfwidths (array-like): Argument for the `rectprism` geometry. Contains **trajectory_data (str): Argument for the `trajectory` geometry. The
the half widths of the rectangular prism in the path to the ASCII trajectory data file. Required.
X, Y, and Z directions. Required. **trajectory_format (str): Argument for the `trajectory` geometry. The
npoints (array-like): Argument for the `rectprism` geometry. Contains format of the trajectory data file. Supported formats are `tecplot`
the number of points in the X, Y, and Z directions (data is a tecplot zone with 3D positional variables) and `batsrus`
to interpolate onto. Required. (data is formatted as described for the `#SATELLITE` command, see SWMF
trajectory_data (str): Argument for the `trajectory` geometry. The path documentation). Required.
to the ASCII trajectory data file. Required.
trajectory_format (str): Argument for the `trajectory` geometry. The
format of the trajectory data file. Supported
formats are `tecplot` (data is a tecplot zone
with 3D positional variables) and `batsrus`
(data is formatted as described for the
`#SATELLITE` command, see SWMF documentation).
Required.
Examples: Examples:
```python ```python
......
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