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

Diagrams_in_doc #257

Merged
merged 6 commits into from
Sep 15, 2023
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions docs/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,22 @@ Analysis

.. automodule:: clouddrift.analysis
:members:
:exclude-members: chunk
:undoc-members:

.. autofunction:: chunk

.. image:: img/chunk.png
:width: 800
:align: center
:alt: chunk schematic

Combined with :func:`clouddrift.analysis.apply_ragged`, :func:`clouddrift.analysis.chunk` can be used to divide a ragged array into equal chunks.

.. image:: img/chunk_ragged.png
:width: 800
:align: center
:alt: ragged array chunk schematic
milancurcic marked this conversation as resolved.
Show resolved Hide resolved

Datasets
--------
Expand Down
Binary file added docs/img/chunk.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/img/chunk_ragged.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/img/ragged_array.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
5 changes: 5 additions & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,11 @@ There are a few ways to retrieve the data, but all typically require time-consum

CloudDrift goals are to *simplify* the necessary steps to get started with the GDP dataset or any Lagrangian datasets, and to provide a cloud-ready library to *accelerate* Lagrangian analysis.

.. image:: img/ragged_array.png
:width: 800
:align: center
:alt: Ragged array schematic

Getting started
---------------

Expand Down