r2r_ctd.__main__

The main entry point for this software, specifically the qa() function.

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

  • Construct a Breakout instance passing path as the sole argument.

  • Construct a ResultAggregator from that breakout instance.

  • Write the geoCSV, the Breakout instance knows where, the ResultAggregator knows the contents.

  • For each station in stations_hex_paths, generate and write the instrument configuration report, requires the companion docker container.

  • Optionally and by default: for each station in 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 ResultAggregator.

Functions

cli(quiet)

test_docker()

Run the docker 'hello-world' container and exit

qa(gen_cnvs, paths, bag)

Run the QA routines on one or more directories.

Module Contents

r2r_ctd.__main__.cli(quiet)
r2r_ctd.__main__.test_docker()

Run the docker ‘hello-world’ container and exit

r2r_ctd.__main__.qa(gen_cnvs: bool, paths: tuple[pathlib.Path, Ellipsis], bag: r2r_ctd.breakout.BagStrictness)

Run the QA routines on one or more directories.