Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add modules for computing transect geometry #324

Merged
merged 11 commits into from
Nov 13, 2020
21 changes: 21 additions & 0 deletions conda_package/docs/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -178,6 +178,17 @@ Ocean Tools
inject_preserve_floodplain


.. currentmodule:: mpas_tools.ocean.transects

.. autosummary::
:toctree: generated/

find_transect_levels_and_weights
interp_mpas_to_transect_triangles
interp_mpas_to_transect_triangle_nodes
interp_transect_grid_to_transect_triangle_nodes
get_outline_segments

Visualization
=============

Expand All @@ -195,6 +206,16 @@ Visualization

mesh_to_triangles

.. currentmodule:: mpas_tools.viz.transects

.. autosummary::
:toctree: generated/

make_triangle_tree
find_transect_cells_and_weights
subdivide_great_circle
cartesian_to_great_circle_distance


.. currentmodule:: mpas_tools.viz.colormaps

Expand Down
2 changes: 2 additions & 0 deletions conda_package/docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,8 @@
# Otherwise, the Attributes parameter list looks different from the Parameters
# list
napoleon_use_ivar = True
# Make sure multiple variable on the same line show up right
napoleon_use_param = False

# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
Expand Down
Loading