Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
actions-user committed Jan 21, 2024
1 parent ba97c30 commit 86d591a
Show file tree
Hide file tree
Showing 366 changed files with 91,417 additions and 1,107 deletions.
1 change: 1 addition & 0 deletions CNAME
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
clouddrift.org

Large diffs are not rendered by default.

585 changes: 585 additions & 0 deletions _autosummary/clouddrift.adapters.gdp.cut_str.html

Large diffs are not rendered by default.

587 changes: 587 additions & 0 deletions _autosummary/clouddrift.adapters.gdp.decode_date.html

Large diffs are not rendered by default.

585 changes: 585 additions & 0 deletions _autosummary/clouddrift.adapters.gdp.drogue_presence.html

Large diffs are not rendered by default.

578 changes: 578 additions & 0 deletions _autosummary/clouddrift.adapters.gdp.fetch_netcdf.html

Large diffs are not rendered by default.

579 changes: 579 additions & 0 deletions _autosummary/clouddrift.adapters.gdp.fill_values.html

Large diffs are not rendered by default.

576 changes: 576 additions & 0 deletions _autosummary/clouddrift.adapters.gdp.get_gdp_metadata.html

Large diffs are not rendered by default.

824 changes: 824 additions & 0 deletions _autosummary/clouddrift.adapters.gdp.html

Large diffs are not rendered by default.

585 changes: 585 additions & 0 deletions _autosummary/clouddrift.adapters.gdp.order_by_date.html

Large diffs are not rendered by default.

583 changes: 583 additions & 0 deletions _autosummary/clouddrift.adapters.gdp.parse_directory_file.html

Large diffs are not rendered by default.

568 changes: 568 additions & 0 deletions _autosummary/clouddrift.adapters.gdp.rowsize.html

Large diffs are not rendered by default.

586 changes: 586 additions & 0 deletions _autosummary/clouddrift.adapters.gdp.str_to_float.html

Large diffs are not rendered by default.

590 changes: 590 additions & 0 deletions _autosummary/clouddrift.adapters.gdp1h.download.html

Large diffs are not rendered by default.

702 changes: 702 additions & 0 deletions _autosummary/clouddrift.adapters.gdp1h.html

Large diffs are not rendered by default.

586 changes: 586 additions & 0 deletions _autosummary/clouddrift.adapters.gdp1h.preprocess.html

Large diffs are not rendered by default.

631 changes: 631 additions & 0 deletions _autosummary/clouddrift.adapters.gdp1h.to_raggedarray.html

Large diffs are not rendered by default.

590 changes: 590 additions & 0 deletions _autosummary/clouddrift.adapters.gdp6h.download.html

Large diffs are not rendered by default.

693 changes: 693 additions & 0 deletions _autosummary/clouddrift.adapters.gdp6h.html

Large diffs are not rendered by default.

586 changes: 586 additions & 0 deletions _autosummary/clouddrift.adapters.gdp6h.preprocess.html

Large diffs are not rendered by default.

622 changes: 622 additions & 0 deletions _autosummary/clouddrift.adapters.gdp6h.to_raggedarray.html

Large diffs are not rendered by default.

569 changes: 569 additions & 0 deletions _autosummary/clouddrift.adapters.glad.get_dataframe.html

Large diffs are not rendered by default.

606 changes: 606 additions & 0 deletions _autosummary/clouddrift.adapters.glad.html

Large diffs are not rendered by default.

569 changes: 569 additions & 0 deletions _autosummary/clouddrift.adapters.glad.to_xarray.html

Large diffs are not rendered by default.

570 changes: 570 additions & 0 deletions _autosummary/clouddrift.adapters.mosaic.get_dataframes.html

Large diffs are not rendered by default.

569 changes: 569 additions & 0 deletions _autosummary/clouddrift.adapters.mosaic.get_file_urls.html

Large diffs are not rendered by default.

570 changes: 570 additions & 0 deletions _autosummary/clouddrift.adapters.mosaic.get_repository_metadata.html

Large diffs are not rendered by default.

632 changes: 632 additions & 0 deletions _autosummary/clouddrift.adapters.mosaic.html

Large diffs are not rendered by default.

569 changes: 569 additions & 0 deletions _autosummary/clouddrift.adapters.mosaic.to_xarray.html

Large diffs are not rendered by default.

568 changes: 568 additions & 0 deletions _autosummary/clouddrift.adapters.subsurface_floats.download.html

Large diffs are not rendered by default.

585 changes: 585 additions & 0 deletions _autosummary/clouddrift.adapters.subsurface_floats.html

Large diffs are not rendered by default.

568 changes: 568 additions & 0 deletions _autosummary/clouddrift.adapters.subsurface_floats.to_xarray.html

Large diffs are not rendered by default.

633 changes: 633 additions & 0 deletions _autosummary/clouddrift.datasets.andro.html

Large diffs are not rendered by default.

635 changes: 635 additions & 0 deletions _autosummary/clouddrift.datasets.gdp1h.html

Large diffs are not rendered by default.

639 changes: 639 additions & 0 deletions _autosummary/clouddrift.datasets.gdp6h.html

Large diffs are not rendered by default.

621 changes: 621 additions & 0 deletions _autosummary/clouddrift.datasets.glad.html

Large diffs are not rendered by default.

1,160 changes: 1,160 additions & 0 deletions _autosummary/clouddrift.datasets.html

Large diffs are not rendered by default.

628 changes: 628 additions & 0 deletions _autosummary/clouddrift.datasets.mosaic.html

Large diffs are not rendered by default.

620 changes: 620 additions & 0 deletions _autosummary/clouddrift.datasets.spotters.html

Large diffs are not rendered by default.

645 changes: 645 additions & 0 deletions _autosummary/clouddrift.datasets.subsurface_floats.html

Large diffs are not rendered by default.

633 changes: 633 additions & 0 deletions _autosummary/clouddrift.datasets.yomaha.html

Large diffs are not rendered by default.

1,103 changes: 1,103 additions & 0 deletions _autosummary/clouddrift.kinematics.html

Large diffs are not rendered by default.

Large diffs are not rendered by default.

604 changes: 604 additions & 0 deletions _autosummary/clouddrift.kinematics.kinetic_energy.html

Large diffs are not rendered by default.

709 changes: 709 additions & 0 deletions _autosummary/clouddrift.kinematics.position_from_velocity.html

Large diffs are not rendered by default.

Large diffs are not rendered by default.

659 changes: 659 additions & 0 deletions _autosummary/clouddrift.kinematics.spin.html

Large diffs are not rendered by default.

666 changes: 666 additions & 0 deletions _autosummary/clouddrift.kinematics.velocity_from_position.html

Large diffs are not rendered by default.

651 changes: 651 additions & 0 deletions _autosummary/clouddrift.pairs.chance_pair.html

Large diffs are not rendered by default.

652 changes: 652 additions & 0 deletions _autosummary/clouddrift.pairs.chance_pairs_from_ragged.html

Large diffs are not rendered by default.

944 changes: 944 additions & 0 deletions _autosummary/clouddrift.pairs.html

Large diffs are not rendered by default.

608 changes: 608 additions & 0 deletions _autosummary/clouddrift.pairs.pair_bounding_box_overlap.html

Large diffs are not rendered by default.

608 changes: 608 additions & 0 deletions _autosummary/clouddrift.pairs.pair_space_distance.html

Large diffs are not rendered by default.

598 changes: 598 additions & 0 deletions _autosummary/clouddrift.pairs.pair_time_distance.html

Large diffs are not rendered by default.

608 changes: 608 additions & 0 deletions _autosummary/clouddrift.pairs.pair_time_overlap.html

Large diffs are not rendered by default.

686 changes: 686 additions & 0 deletions _autosummary/clouddrift.plotting.html

Large diffs are not rendered by default.

677 changes: 677 additions & 0 deletions _autosummary/clouddrift.plotting.plot_ragged.html

Large diffs are not rendered by default.

649 changes: 649 additions & 0 deletions _autosummary/clouddrift.ragged.apply_ragged.html

Large diffs are not rendered by default.

654 changes: 654 additions & 0 deletions _autosummary/clouddrift.ragged.chunk.html

Large diffs are not rendered by default.

1,183 changes: 1,183 additions & 0 deletions _autosummary/clouddrift.ragged.html

Large diffs are not rendered by default.

607 changes: 607 additions & 0 deletions _autosummary/clouddrift.ragged.prune.html

Large diffs are not rendered by default.

615 changes: 615 additions & 0 deletions _autosummary/clouddrift.ragged.ragged_to_regular.html

Large diffs are not rendered by default.

604 changes: 604 additions & 0 deletions _autosummary/clouddrift.ragged.regular_to_ragged.html

Large diffs are not rendered by default.

593 changes: 593 additions & 0 deletions _autosummary/clouddrift.ragged.rowsize_to_index.html

Large diffs are not rendered by default.

634 changes: 634 additions & 0 deletions _autosummary/clouddrift.ragged.segment.html

Large diffs are not rendered by default.

668 changes: 668 additions & 0 deletions _autosummary/clouddrift.ragged.subset.html

Large diffs are not rendered by default.

614 changes: 614 additions & 0 deletions _autosummary/clouddrift.ragged.unpack.html

Large diffs are not rendered by default.

919 changes: 919 additions & 0 deletions _autosummary/clouddrift.raggedarray.RaggedArray.html

Large diffs are not rendered by default.

551 changes: 551 additions & 0 deletions _autosummary/clouddrift.raggedarray.html

Large diffs are not rendered by default.

644 changes: 644 additions & 0 deletions _autosummary/clouddrift.signal.analytic_signal.html

Large diffs are not rendered by default.

626 changes: 626 additions & 0 deletions _autosummary/clouddrift.signal.cartesian_to_rotary.html

Large diffs are not rendered by default.

614 changes: 614 additions & 0 deletions _autosummary/clouddrift.signal.ellipse_parameters.html

Large diffs are not rendered by default.

899 changes: 899 additions & 0 deletions _autosummary/clouddrift.signal.html

Large diffs are not rendered by default.

618 changes: 618 additions & 0 deletions _autosummary/clouddrift.signal.modulated_ellipse_signal.html

Large diffs are not rendered by default.

620 changes: 620 additions & 0 deletions _autosummary/clouddrift.signal.rotary_to_cartesian.html

Large diffs are not rendered by default.

607 changes: 607 additions & 0 deletions _autosummary/clouddrift.sphere.bearing.html

Large diffs are not rendered by default.

621 changes: 621 additions & 0 deletions _autosummary/clouddrift.sphere.cartesian_to_spherical.html

Large diffs are not rendered by default.

620 changes: 620 additions & 0 deletions _autosummary/clouddrift.sphere.cartesian_to_tangentplane.html

Large diffs are not rendered by default.

589 changes: 589 additions & 0 deletions _autosummary/clouddrift.sphere.coriolis_frequency.html

Large diffs are not rendered by default.

597 changes: 597 additions & 0 deletions _autosummary/clouddrift.sphere.cumulative_distance.html

Large diffs are not rendered by default.

612 changes: 612 additions & 0 deletions _autosummary/clouddrift.sphere.distance.html

Large diffs are not rendered by default.

1,317 changes: 1,317 additions & 0 deletions _autosummary/clouddrift.sphere.html

Large diffs are not rendered by default.

622 changes: 622 additions & 0 deletions _autosummary/clouddrift.sphere.plane_to_sphere.html

Large diffs are not rendered by default.

611 changes: 611 additions & 0 deletions _autosummary/clouddrift.sphere.position_from_distance_and_bearing.html

Large diffs are not rendered by default.

616 changes: 616 additions & 0 deletions _autosummary/clouddrift.sphere.recast_lon.html

Large diffs are not rendered by default.

599 changes: 599 additions & 0 deletions _autosummary/clouddrift.sphere.recast_lon180.html

Large diffs are not rendered by default.

599 changes: 599 additions & 0 deletions _autosummary/clouddrift.sphere.recast_lon360.html

Large diffs are not rendered by default.

623 changes: 623 additions & 0 deletions _autosummary/clouddrift.sphere.sphere_to_plane.html

Large diffs are not rendered by default.

629 changes: 629 additions & 0 deletions _autosummary/clouddrift.sphere.spherical_to_cartesian.html

Large diffs are not rendered by default.

617 changes: 617 additions & 0 deletions _autosummary/clouddrift.sphere.tangentplane_to_cartesian.html

Large diffs are not rendered by default.

1,088 changes: 1,088 additions & 0 deletions _autosummary/clouddrift.wavelet.html

Large diffs are not rendered by default.

605 changes: 605 additions & 0 deletions _autosummary/clouddrift.wavelet.morse_amplitude.html

Large diffs are not rendered by default.

629 changes: 629 additions & 0 deletions _autosummary/clouddrift.wavelet.morse_freq.html

Large diffs are not rendered by default.

631 changes: 631 additions & 0 deletions _autosummary/clouddrift.wavelet.morse_logspace_freq.html

Large diffs are not rendered by default.

600 changes: 600 additions & 0 deletions _autosummary/clouddrift.wavelet.morse_properties.html

Large diffs are not rendered by default.

631 changes: 631 additions & 0 deletions _autosummary/clouddrift.wavelet.morse_wavelet.html

Large diffs are not rendered by default.

690 changes: 690 additions & 0 deletions _autosummary/clouddrift.wavelet.morse_wavelet_transform.html

Large diffs are not rendered by default.

621 changes: 621 additions & 0 deletions _autosummary/clouddrift.wavelet.wavelet_transform.html

Large diffs are not rendered by default.

Binary file added _images/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.
820 changes: 820 additions & 0 deletions _modules/clouddrift/adapters/gdp.html

Large diffs are not rendered by default.

1,091 changes: 1,091 additions & 0 deletions _modules/clouddrift/adapters/gdp1h.html

Large diffs are not rendered by default.

978 changes: 978 additions & 0 deletions _modules/clouddrift/adapters/gdp6h.html

Large diffs are not rendered by default.

591 changes: 591 additions & 0 deletions _modules/clouddrift/adapters/glad.html

Large diffs are not rendered by default.

633 changes: 633 additions & 0 deletions _modules/clouddrift/adapters/mosaic.html

Large diffs are not rendered by default.

674 changes: 674 additions & 0 deletions _modules/clouddrift/adapters/subsurface_floats.html

Large diffs are not rendered by default.

1,102 changes: 1,102 additions & 0 deletions _modules/clouddrift/datasets.html

Large diffs are not rendered by default.

1,418 changes: 1,418 additions & 0 deletions _modules/clouddrift/kinematics.html

Large diffs are not rendered by default.

1,007 changes: 1,007 additions & 0 deletions _modules/clouddrift/pairs.html

Large diffs are not rendered by default.

693 changes: 693 additions & 0 deletions _modules/clouddrift/plotting.html

Large diffs are not rendered by default.

1,341 changes: 1,341 additions & 0 deletions _modules/clouddrift/ragged.html

Large diffs are not rendered by default.

999 changes: 999 additions & 0 deletions _modules/clouddrift/raggedarray.html

Large diffs are not rendered by default.

951 changes: 951 additions & 0 deletions _modules/clouddrift/signal.html

Large diffs are not rendered by default.

1,320 changes: 1,320 additions & 0 deletions _modules/clouddrift/sphere.html

Large diffs are not rendered by default.

1,322 changes: 1,322 additions & 0 deletions _modules/clouddrift/wavelet.html

Large diffs are not rendered by default.

486 changes: 486 additions & 0 deletions _modules/index.html

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
clouddrift.adapters.gdp.cast\_float64\_variables\_to\_float32
=============================================================

.. currentmodule:: clouddrift.adapters.gdp

.. autofunction:: cast_float64_variables_to_float32
6 changes: 6 additions & 0 deletions _sources/_autosummary/clouddrift.adapters.gdp.cut_str.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
clouddrift.adapters.gdp.cut\_str
================================

.. currentmodule:: clouddrift.adapters.gdp

.. autofunction:: cut_str
6 changes: 6 additions & 0 deletions _sources/_autosummary/clouddrift.adapters.gdp.decode_date.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
clouddrift.adapters.gdp.decode\_date
====================================

.. currentmodule:: clouddrift.adapters.gdp

.. autofunction:: decode_date
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
clouddrift.adapters.gdp.drogue\_presence
========================================

.. currentmodule:: clouddrift.adapters.gdp

.. autofunction:: drogue_presence
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
clouddrift.adapters.gdp.fetch\_netcdf
=====================================

.. currentmodule:: clouddrift.adapters.gdp

.. autofunction:: fetch_netcdf
6 changes: 6 additions & 0 deletions _sources/_autosummary/clouddrift.adapters.gdp.fill_values.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
clouddrift.adapters.gdp.fill\_values
====================================

.. currentmodule:: clouddrift.adapters.gdp

.. autofunction:: fill_values
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
clouddrift.adapters.gdp.get\_gdp\_metadata
==========================================

.. currentmodule:: clouddrift.adapters.gdp

.. autofunction:: get_gdp_metadata
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
clouddrift.adapters.gdp.order\_by\_date
=======================================

.. currentmodule:: clouddrift.adapters.gdp

.. autofunction:: order_by_date
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
clouddrift.adapters.gdp.parse\_directory\_file
==============================================

.. currentmodule:: clouddrift.adapters.gdp

.. autofunction:: parse_directory_file
6 changes: 6 additions & 0 deletions _sources/_autosummary/clouddrift.adapters.gdp.rowsize.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
clouddrift.adapters.gdp.rowsize
===============================

.. currentmodule:: clouddrift.adapters.gdp

.. autofunction:: rowsize
41 changes: 41 additions & 0 deletions _sources/_autosummary/clouddrift.adapters.gdp.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
clouddrift.adapters.gdp
=======================

.. automodule:: clouddrift.adapters.gdp
:members:







.. rubric:: Functions

.. autosummary::
:toctree:

cast_float64_variables_to_float32
cut_str
decode_date
drogue_presence
fetch_netcdf
fill_values
get_gdp_metadata
order_by_date
parse_directory_file
rowsize
str_to_float













Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
clouddrift.adapters.gdp.str\_to\_float
======================================

.. currentmodule:: clouddrift.adapters.gdp

.. autofunction:: str_to_float
6 changes: 6 additions & 0 deletions _sources/_autosummary/clouddrift.adapters.gdp1h.download.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
clouddrift.adapters.gdp1h.download
==================================

.. currentmodule:: clouddrift.adapters.gdp1h

.. autofunction:: download
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
clouddrift.adapters.gdp1h.preprocess
====================================

.. currentmodule:: clouddrift.adapters.gdp1h

.. autofunction:: preprocess
33 changes: 33 additions & 0 deletions _sources/_autosummary/clouddrift.adapters.gdp1h.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
clouddrift.adapters.gdp1h
=========================

.. automodule:: clouddrift.adapters.gdp1h
:members:







.. rubric:: Functions

.. autosummary::
:toctree:

download
preprocess
to_raggedarray













Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
clouddrift.adapters.gdp1h.to\_raggedarray
=========================================

.. currentmodule:: clouddrift.adapters.gdp1h

.. autofunction:: to_raggedarray
6 changes: 6 additions & 0 deletions _sources/_autosummary/clouddrift.adapters.gdp6h.download.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
clouddrift.adapters.gdp6h.download
==================================

.. currentmodule:: clouddrift.adapters.gdp6h

.. autofunction:: download
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
clouddrift.adapters.gdp6h.preprocess
====================================

.. currentmodule:: clouddrift.adapters.gdp6h

.. autofunction:: preprocess
33 changes: 33 additions & 0 deletions _sources/_autosummary/clouddrift.adapters.gdp6h.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
clouddrift.adapters.gdp6h
=========================

.. automodule:: clouddrift.adapters.gdp6h
:members:







.. rubric:: Functions

.. autosummary::
:toctree:

download
preprocess
to_raggedarray













Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
clouddrift.adapters.gdp6h.to\_raggedarray
=========================================

.. currentmodule:: clouddrift.adapters.gdp6h

.. autofunction:: to_raggedarray
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
clouddrift.adapters.glad.get\_dataframe
=======================================

.. currentmodule:: clouddrift.adapters.glad

.. autofunction:: get_dataframe
32 changes: 32 additions & 0 deletions _sources/_autosummary/clouddrift.adapters.glad.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
clouddrift.adapters.glad
========================

.. automodule:: clouddrift.adapters.glad
:members:







.. rubric:: Functions

.. autosummary::
:toctree:

get_dataframe
to_xarray













6 changes: 6 additions & 0 deletions _sources/_autosummary/clouddrift.adapters.glad.to_xarray.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
clouddrift.adapters.glad.to\_xarray
===================================

.. currentmodule:: clouddrift.adapters.glad

.. autofunction:: to_xarray
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
clouddrift.adapters.mosaic.get\_dataframes
==========================================

.. currentmodule:: clouddrift.adapters.mosaic

.. autofunction:: get_dataframes
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
clouddrift.adapters.mosaic.get\_file\_urls
==========================================

.. currentmodule:: clouddrift.adapters.mosaic

.. autofunction:: get_file_urls
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
clouddrift.adapters.mosaic.get\_repository\_metadata
====================================================

.. currentmodule:: clouddrift.adapters.mosaic

.. autofunction:: get_repository_metadata
34 changes: 34 additions & 0 deletions _sources/_autosummary/clouddrift.adapters.mosaic.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
clouddrift.adapters.mosaic
==========================

.. automodule:: clouddrift.adapters.mosaic
:members:







.. rubric:: Functions

.. autosummary::
:toctree:

get_dataframes
get_file_urls
get_repository_metadata
to_xarray













Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
clouddrift.adapters.mosaic.to\_xarray
=====================================

.. currentmodule:: clouddrift.adapters.mosaic

.. autofunction:: to_xarray
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
clouddrift.adapters.subsurface\_floats.download
===============================================

.. currentmodule:: clouddrift.adapters.subsurface_floats

.. autofunction:: download
Loading

0 comments on commit 86d591a

Please sign in to comment.