r2r_ctd.__main__
================

.. py:module:: r2r_ctd.__main__

.. autoapi-nested-parse::

   The main entry point for this software, specifically the :py:func:`qa` function.

   Inside the that qa func, the basic architecture is, for each ``path`` in ``paths``:

   * Construct a :py:class:`~r2r_ctd.breakout.Breakout` instance passing ``path`` as the sole argument.
   * Construct a :py:class:`~r2r_ctd.reporting.ResultAggregator` from that breakout instance.
   * Write the geoCSV, the :py:class:`~r2r_ctd.breakout.Breakout` instance knows where, the :py:class:`~r2r_ctd.reporting.ResultAggregator` knows the contents.
   * For each station in :py:class:`~r2r_ctd.breakout.Breakout.stations_hex_paths`, generate and write the instrument configuration report, requires the companion docker container.
   * Optionally and by default: for each station in :py:class:`~r2r_ctd.breakout.Breakout.stations_hex_paths`, generate and write the two cnv products, requires the companion docker container.
   * Finally, write the xml QA report.


   The majority of the work of the QA is being done by the :py:class:`~r2r_ctd.reporting.ResultAggregator`.



Functions
---------

.. autoapisummary::

   r2r_ctd.__main__.cli
   r2r_ctd.__main__.test_docker
   r2r_ctd.__main__.qa


Module Contents
---------------

.. py:function:: cli(quiet)

.. py:function:: test_docker()

   Run the docker 'hello-world' container and exit


.. py:function:: qa(gen_cnvs: bool, paths: tuple[pathlib.Path, Ellipsis])

   Run the QA routines on one or more directories.