From fec6c1ef56588ac37bf960d9172b244aec76f950 Mon Sep 17 00:00:00 2001 From: Bryce Irving Date: Tue, 29 Apr 2025 15:59:41 -0600 Subject: [PATCH] fix typo in python api docs --- python/mantaray/core.py | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/python/mantaray/core.py b/python/mantaray/core.py index 95ad896f..b1d01dff 100644 --- a/python/mantaray/core.py +++ b/python/mantaray/core.py @@ -34,11 +34,11 @@ def single_ray( Time step for the simulation bathymetry : str Path to a netCDF file containing the bathymetry file. It is expected - to have x and y dimensions as floats and depth (x, y) as a float, + to have x and y dimensions as floats and depth (y, x) as a float, where depth is zero at surface and positive downwards. current : str Paths to a netCDF file containing the current field. It is expected - to have x and y dimensions as floats and u(x,y) and v(x,y) as floats. + to have x and y dimensions as floats and u(y,x) and v(y,x) as floats. Return ------ @@ -96,11 +96,11 @@ def ray_tracing( Time step for the simulation bathymetry : str Path to a netCDF file containing the bathymetry file. It is expected - x and y dimensions as floats and depth (x, y) as a float, where + x and y dimensions as floats and depth (y, x) as a float, where depth is zero at surface and positive downwards. current : str Paths to a netCDF file containing the current field. It is expected - to have x and y dimensions as floats and u(x,y) and v(x,y) as floats. + to have x and y dimensions as floats and u(y,x) and v(y,x) as floats. Returns -------