0.2.8

docs/api/coordinates.md

@@ -5,9 +5,6 @@
 
 ## Coordinates
 
-Constructor
-
-
 ```{eval-rst}
 .. autosummary::
    :toctree: ../_autosummary
@@ -22,23 +19,19 @@ Methods
    :toctree: ../_autosummary
 
    Coordinates.isdim
-   Coordinates.get_query
    Coordinates.to_index
    Coordinates.equals
-   Coordinates.to_dict
    Coordinates.copy
-   Coordinates.drop_dims 
-   Coordinates.drop_coords 
+   Coordinates.drop_dims
+   Coordinates.drop_coords
 ```
 
-### Coordinate
-
-Constructor
+## Coordinate
 
 ```{eval-rst}
 .. autosummary::
    :toctree: ../_autosummary
-   
+
    Coordinate
 ```
 
@@ -49,9 +42,11 @@ Attributes
    :toctree: ../_autosummary
 
    Coordinate.dtype
-   Coordinate.ndim
    Coordinate.shape
+   Coordinate.size
+   Coordinate.dim
    Coordinate.values
+   Coordinate.name
 ```
 
 Methods
@@ -60,22 +55,32 @@ Methods
 .. autosummary::
    :toctree: ../_autosummary
 
-   Coordinate.to_index
-   Coordinate.isscalar
-   Coordinate.isdense
-   Coordinate.isinterp
+   Coordinate.isdim
+   Coordinate.isregular
+   Coordinate.equals
+   Coordinate.copy
 ```
 
+## AxisCoordinate
+
+```{eval-rst}
+.. autosummary::
+   :toctree: ../_autosummary
 
-### ScalarCoordinate
+   AxisCoordinate
+```
 
-Constructor
+Attributes
 
 ```{eval-rst}
 .. autosummary::
    :toctree: ../_autosummary
 
-   ScalarCoordinate
+   AxisCoordinate.ndim
+   AxisCoordinate.empty
+   AxisCoordinate.indices
+   AxisCoordinate.start
+   AxisCoordinate.end
 ```
 
 Methods
@@ -84,15 +89,27 @@ Methods
 .. autosummary::
    :toctree: ../_autosummary
 
-   ScalarCoordinate.isvalid
-   ScalarCoordinate.equals
-   ScalarCoordinate.to_index
-   ScalarCoordinate.to_dict
+   AxisCoordinate.isregular
+   AxisCoordinate.get_sampling_interval
+   AxisCoordinate.to_regular
+   AxisCoordinate.get_split_indices
+   AxisCoordinate.get_discontinuities
+   AxisCoordinate.get_availabilities
+   AxisCoordinate.simplify
+   AxisCoordinate.to_index
+   AxisCoordinate.to_dataarray
 ```
 
-### DenseCoordinate
+## ScalarCoordinate
+
+```{eval-rst}
+.. autosummary::
+   :toctree: ../_autosummary
+
+   ScalarCoordinate
+```
 
-Constructor
+## DenseCoordinate
 
 ```{eval-rst}
 .. autosummary::
@@ -101,22 +118,28 @@ Constructor
    DenseCoordinate
 ```
 
-Methods
+Attributes
 
 ```{eval-rst}
 .. autosummary::
    :toctree: ../_autosummary
 
-   DenseCoordinate.isvalid
    DenseCoordinate.index
-   DenseCoordinate.get_indexer
-   DenseCoordinate.slice_indexer
-   DenseCoordinate.to_dict
 ```
 
-### InterpCoordinate
+Methods
+
+```{eval-rst}
+.. autosummary::
+   :toctree: ../_autosummary
 
-Constructor
+   DenseCoordinate.from_block
+   DenseCoordinate.get_sampling_interval
+   DenseCoordinate.to_regular
+   DenseCoordinate.simplify
+```
+
+## InterpCoordinate
 
 ```{eval-rst}
 .. autosummary::
@@ -127,19 +150,14 @@ Constructor
 
 Attributes
 
-
 ```{eval-rst}
 .. autosummary::
    :toctree: ../_autosummary
 
    InterpCoordinate.tie_indices
    InterpCoordinate.tie_values
-   InterpCoordinate.empty
-   InterpCoordinate.dtype
-   InterpCoordinate.ndim
-   InterpCoordinate.shape
-   InterpCoordinate.indices
-   InterpCoordinate.values
+   InterpCoordinate.sampling_interval
+   InterpCoordinate.tolerance
 ```
 
 Methods
@@ -148,24 +166,13 @@ Methods
 .. autosummary::
    :toctree: ../_autosummary
 
-   InterpCoordinate.isvalid
-   InterpCoordinate.equals
-   InterpCoordinate.get_value
-   InterpCoordinate.format_index
-   InterpCoordinate.slice_index
-   InterpCoordinate.get_indexer
-   InterpCoordinate.slice_indexer
-   InterpCoordinate.decimate
+   InterpCoordinate.from_block
+   InterpCoordinate.to_regular
+   InterpCoordinate.get_sampling_interval
    InterpCoordinate.simplify
-   InterpCoordinate.get_discontinuities
-   InterpCoordinate.from_array
-   InterpCoordinate.to_dict
 ```
 
-
-### SampledCoordinate
-
-Constructor
+## SampledCoordinate
 
 ```{eval-rst}
 .. autosummary::
@@ -176,7 +183,6 @@ Constructor
 
 Attributes
 
-
 ```{eval-rst}
 .. autosummary::
    :toctree: ../_autosummary
@@ -185,12 +191,6 @@ Attributes
    SampledCoordinate.tie_lengths
    SampledCoordinate.tie_indices
    SampledCoordinate.sampling_interval
-   SampledCoordinate.empty
-   SampledCoordinate.dtype
-   SampledCoordinate.ndim
-   SampledCoordinate.shape
-   SampledCoordinate.indices
-   SampledCoordinate.values
 ```
 
 Methods
@@ -199,18 +199,17 @@ Methods
 .. autosummary::
    :toctree: ../_autosummary
 
-   SampledCoordinate.concat
-   SampledCoordinate.decimate
-   SampledCoordinate.equals
-   SampledCoordinate.from_array
    SampledCoordinate.from_block
-   SampledCoordinate.get_indexer
    SampledCoordinate.get_sampling_interval
-   SampledCoordinate.get_split_indices
-   SampledCoordinate.get_value
-   SampledCoordinate.isvalid
+   SampledCoordinate.to_regular
    SampledCoordinate.simplify
-   SampledCoordinate.slice_index
-   SampledCoordinate.slice_indexer
-   SampledCoordinate.to_dict
-```
+```
+
+## Functions
+
+```{eval-rst}
+.. autosummary::
+   :toctree: ../_autosummary
+
+   get_sampling_interval
+```

docs/api/index.md

@@ -13,5 +13,6 @@ picking
 processing
 signal
 synthetics
+testing
 virtual
 ```

docs/api/synthetics.md

@@ -10,5 +10,4 @@
 
    wavelet_wavefronts
    randn_wavefronts
-   dummy
 ```

docs/api/testing.md

@@ -0,0 +1,12 @@
+```{eval-rst}
+.. currentmodule:: xdas.testing
+```
+
+# xdas.testing
+
+```{eval-rst}
+.. autosummary::
+   :toctree: ../_autosummary
+
+   dummy
+```

docs/api/xdas.md

@@ -31,6 +31,7 @@
    concat
    concatenate
    concat_coords
+   get_sampling_interval
    split
    plot_availability
 ```
@@ -122,8 +123,6 @@ Methods
    DataArray.from_stream
    DataArray.to_netcdf
    DataArray.from_netcdf
-   DataArray.to_dict
-   DataArray.from_dict
    DataArray.plot
 ```
 

docs/conf.py

@@ -4,14 +4,16 @@
 # list see the documentation:
 # https://www.sphinx-doc.org/en/master/usage/configuration.html
 
+from xdas import __version__
+
 # -- Project information -----------------------------------------------------
 
 project = "xdas"
 copyright = "2024, Alister Trabattoni"
 author = "Alister Trabattoni"
 
 # The full version, including alpha/beta/rc tags
-release = "0.2.7"
+release = __version__
 
 
 # -- General configuration ---------------------------------------------------
@@ -86,13 +88,13 @@
 }
 
 # -- Generate dummy data -----------------------------------------------------
-import os  # noqa: E402
+import os
 
-import h5py  # noqa: E402
-import numpy as np  # noqa: E402
+import h5py
+import numpy as np
 
-import xdas as xd  # noqa: E402
-from xdas.synthetics import wavelet_wavefronts  # noqa: E402
+import xdas as xd
+from xdas.synthetics import wavelet_wavefronts
 
 dirpath = os.path.join(os.path.split(__file__)[0], "_data")
 if not os.path.exists(dirpath):