Merge pull request #48 from ocean-uhh/docs-update-1

DOC update overview

Author: ysorge

docs/source/about.rst

@@ -0,0 +1,42 @@
+About CTD Tools
+===============
+
+CTD Tools is a Python library for reading, converting, and plotting oceanographic sensor data from various instruments and formats. The package is designed to work seamlessly with data from moored instruments and CTD profiles, supporting multiple file formats commonly used in oceanographic research.
+
+**Key Features:**
+
+* **Multiple Format Support**: Read data from Seabird CNV files, RBR RSK files, NetCDF, CSV, Nortek ASCII, and more
+* **Flexible Data Processing**: Convert between formats, resample data, extract subsets, and calculate statistics
+* **Rich Visualization**: Create T-S diagrams, vertical profiles, and time series plots
+* **Command-Line Interface**: Easy-to-use CLI for common data processing tasks
+* **Extensible Architecture**: Modular design allows easy addition of new readers, writers, and plotters
+* **Parameter Mapping**: Handle different column naming conventions across file formats
+
+**Supported Instruments:**
+
+* Seabird CTD instruments (CNV format)
+* RBR CTD and moored instruments (RSK format)
+* Nortek ADCP instruments (ASCII format)
+* Sea & Sun Technology instruments (TOB format)
+* General CSV and NetCDF files
+
+**Project Goals:**
+
+CTD Tools aims to simplify the process of working with oceanographic sensor data by providing:
+
+1. **Standardized Data Access**: Convert proprietary formats to standard xarray Datasets
+2. **Consistent API**: Uniform interface across different instrument types
+3. **CF Convention Support**: Ensure output data follows Climate and Forecast metadata conventions
+4. **Research Reproducibility**: Enable easy sharing and reprocessing of oceanographic datasets
+5. **Educational Use**: Provide tools suitable for teaching oceanographic data analysis
+
+**Who Should Use CTD Tools:**
+
+* Oceanographic researchers working with CTD and mooring data
+* Students learning oceanographic data analysis
+* Data managers converting legacy datasets
+* Anyone needing to visualize or process oceanographic sensor data
+
+**Community and Support:**
+
+CTD Tools is developed and maintained by the oceanographic community. We welcome contributions, bug reports, and feature requests through our GitHub repository.

docs/source/ctdtools.rst

@@ -1,19 +1,162 @@
-:mod:`CTD Tools API`
------------------------
+API Reference
+=============
+
+This section provides detailed API documentation for all CTD Tools modules.
+
+Readers
+-------
 
 .. automodule:: ctd_tools.readers
+   :no-members:
+   :show-inheritance:
+
+Base Reader Classes
+^^^^^^^^^^^^^^^^^^^
+
+.. autoclass:: ctd_tools.readers.base.AbstractReader
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Specific Reader Classes
+^^^^^^^^^^^^^^^^^^^^^^^
+
+.. autoclass:: ctd_tools.readers.SbeCnvReader
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. autoclass:: ctd_tools.readers.NetCdfReader
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. autoclass:: ctd_tools.readers.CsvReader
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. autoclass:: ctd_tools.readers.RbrRskReader
    :members:
    :undoc-members:
+   :show-inheritance:
+
+.. autoclass:: ctd_tools.readers.RbrRskAutoReader
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. autoclass:: ctd_tools.readers.RbrAsciiReader
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. autoclass:: ctd_tools.readers.NortekAsciiReader
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Writers
+-------
 
 .. automodule:: ctd_tools.writers
+   :no-members:
+   :show-inheritance:
+
+Base Writer Classes
+^^^^^^^^^^^^^^^^^^^
+
+.. autoclass:: ctd_tools.writers.base.AbstractWriter
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Specific Writer Classes
+^^^^^^^^^^^^^^^^^^^^^^^
+
+.. autoclass:: ctd_tools.writers.NetCdfWriter
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. autoclass:: ctd_tools.writers.CsvWriter
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. autoclass:: ctd_tools.writers.ExcelWriter
    :members:
    :undoc-members:
+   :show-inheritance:
+
+Plotters
+--------
 
 .. automodule:: ctd_tools.plotters
+   :no-members:
+   :show-inheritance:
+
+Base Plotter Classes
+^^^^^^^^^^^^^^^^^^^^
+
+.. autoclass:: ctd_tools.plotters.base.AbstractPlotter
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Specific Plotter Classes
+^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. autoclass:: ctd_tools.plotters.TsDiagramPlotter
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. autoclass:: ctd_tools.plotters.ProfilePlotter
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. autoclass:: ctd_tools.plotters.TimeSeriesPlotter
    :members:
    :undoc-members:
+   :show-inheritance:
+
+.. autoclass:: ctd_tools.plotters.TimeSeriesPlotterMulti
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Processors
+----------
 
 .. automodule:: ctd_tools.processors
+   :no-members:
+   :show-inheritance:
+
+Base Processor Classes
+^^^^^^^^^^^^^^^^^^^^^^
+
+.. autoclass:: ctd_tools.processors.base.AbstractProcessor
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Specific Processor Classes
+^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. autoclass:: ctd_tools.processors.SubsetProcessor
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. autoclass:: ctd_tools.processors.ResampleProcessor
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. autoclass:: ctd_tools.processors.StatisticsProcessor
    :members:
    :undoc-members:
+   :show-inheritance:
 

docs/source/index.rst

@@ -2,11 +2,9 @@
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-:parser: myst_parser.sphinx_ # this is the markdown parser
 
-=============================================================
-CTD Tools: Methods for working with oceanographic sensor data
-=============================================================
+Welcome to CTD Tools documentation!
+====================================
 
 `ctd-tools` is a library to process data from oceanographic sensor formats.
 
@@ -15,9 +13,18 @@ For recommendations or bug reports, please visit https://github.com/ocean-uhh/ct
 
 .. toctree::
    :maxdepth: 2
-   :caption: Overview
+   :caption: Getting started
+
+   about
+   installation
+
+
+.. toctree::
+   :maxdepth: 2
+   :caption: User guide
+
+   user_guide
 
-   overview
 
 .. toctree::
    :maxdepth: 2
@@ -26,10 +33,10 @@ For recommendations or bug reports, please visit https://github.com/ocean-uhh/ct
    GitHub Repo <http://github.com/ocean-uhh/ctd-tools>
    ctdtools
 
-.. toctree::
-   :maxdepth: 2
-   :caption: Indices and tables
 
-   genindex
-   modindex
-   search
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`