Skip to content

Commit 1a7602f

Browse files
authored
Merge pull request #232 from knutfrode/dev
Final updates to doc frontpage
2 parents 78c8e88 + 8a418cd commit 1a7602f

1 file changed

Lines changed: 7 additions & 4 deletions

File tree

docs/source/index.rst

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ For Ragged datasets time is a 2D array with dimensions for trajectory and observ
6363

6464
TrajAn will detect which type of dataset you have and you will have access to the appropriate methods for the type data layout. `Contiguous ragged <https://cfconventions.org/Data/cf-conventions/cf-conventions-1.10/cf-conventions.html#_contiguous_ragged_array_representation_of_trajectories>`_ and `nc_particles <https://noaa-orr-erd.github.io/nc_particles/nc_particle_standard.html>`_ format are internally converted to Ragged format.
6565

66-
While the Ragged format is more general it often limits analysis that require trajectories to be sampled at the same points, you can therefor convert a Ragged dataset to Orthogonal by using :meth:`xarray.Dataset.traj.gridtime`.
66+
While the Ragged format is more general it often limits analysis that require trajectories to be sampled at the same points, you can therefore convert a Ragged dataset to Orthogonal by using :meth:`ds.traj.gridtime <xarray.Dataset.traj.gridtime>`.
6767

6868
Methods applicable to both types of datasets can be found in: `.traj accessor <https://opendrift.github.io/trajan/api.html#dataset>`_, methods for Orthogonal datasets: :class:`trajan.traj.orthogonal.Orthogonal`, and Ragged: :class:`trajan.traj.ragged.Ragged`. All methods are forwarded to the accessor, so you call the methods on :mod:`ds.traj`:
6969

@@ -74,9 +74,12 @@ Methods applicable to both types of datasets can be found in: `.traj accessor <h
7474
7575
7676
Generic plotting is available in the standard `Xarray` way, and strives to stay as close to `matplotlib` as possible:
77-
:attr:`ds.traj.plot <xarray.Dataset.traj.plot>` (see :class:`trajan.plot.Plot`)
78-
TrajAn also contains an animation builder mechanism the can be chained:
79-
:attr:`ds.traj.animate <xarray.Dataset.traj.animate>` (see :class:`trajan.animation.Animation`)
77+
78+
:attr:`ds.traj.plot() <xarray.Dataset.traj.plot>`
79+
80+
TrajAn also contains an `animation builder mechanism <https://opendrift.github.io/trajan/gallery/example_animation.html>`_:
81+
82+
:attr:`ds.traj.animate() <xarray.Dataset.traj.animate>`
8083

8184
Contents
8285
--------

0 commit comments

Comments
 (0)