Pairs module (#330)

* Function to return time overlaps

* Bounding box overlap function

* Pair-wise distance implementation

* Distance functions

* Fix docstrings

* Implement chance_pair

* First implementation of chance_pairs; need to return pair indices

* Formatting

* Add pairs module to docs

* Return only chance pairs; include pair indices in the result

* Refactor pair_time_overlap to return indices

* Refactor pair_bounding_box_overlap to return indices

* Tolerance -> distance

* WIP indices

* Fix index slicing

* It works

* Fix test to reflect updated chance_pair interface

* Raise if only time1 or only time2 are provided

* Bump minor version

* docstrings rewrites

* lint

* chance_pairs_from_ragged and update docstring

* temporal distance

* Allow ragged.unpack to receive np.integer for rows

* Test chance_pairs_from_ragged

* Bounding box overlap fix for antimeridian

* Raise on bad rowsize input and update docstrings

* Add pairs to top-level scope

---------

Co-authored-by: Shane Elipot <selipot@miami.edu>

Author: milancurcic

clouddrift/__init__.py

@@ -6,6 +6,7 @@
 import clouddrift.adapters
 import clouddrift.datasets
 import clouddrift.kinematics
+import clouddrift.pairs
 import clouddrift.plotting
 import clouddrift.ragged
 import clouddrift.signal