Development and debugging switches
Settings for working on ctdcast itself, or for finding out why a report or a run looks the way it
does. None of them is needed to process a cruise, and ctdcast init writes none of them.
Debugging the reports
Switch |
What it does |
|---|---|
|
Under every embedded figure, a line naming the page slot, the draw function, the figure
size in inches and the PNG size in pixels. Use it to find a figure drawn wider than the
slot it is shown in, which shrinks its text. Any value other than empty, |
|
Adds a |
|
A figure that fails to draw is normally left out with a warning (most panels also show a note on the page saying why). Set this to raise the error instead, with its traceback: from ctdcast.reports._vendored import design_tokens
design_tokens.RAISE_ON_PLOT_ERROR = True
It is read each time a figure is drawn, so set it before calling |
|
The |
The shared report layer under ctdcast/reports/_vendored/ is kept byte-identical with ctdcast’s
sibling packages; python -m ctdcast.reports._vendored.check reports any difference from its
manifest. Change those files only together with the siblings.
Processing switches
data_processing.allow_unappliedtruelets stage 3 run whendata_processing.stepslists a Sea-Bird step it has no applier for: the step is skipped, named in a warning, inhistoryand in the stage-3 file’sdata_processing_steps. The default,false, refuses such a config, because the steps after it would run on data that step was meant to change first and the stage-3 file would look complete. Every step ctdcast lists today has an applier, so the switch currently has no effect; it is kept for a step added to the table before its applier.splitandbinavglisted understeps(instead of in a product) are refused either way.CTDCAST_CONFIG_DIRThe per-user folder the institution and platform registries are read from (default
$XDG_CONFIG_HOME/ctdcast, else~/.config/ctdcast); see Registries.
The demo report
scripts/make_demo.py rebuilds the published demo in docs/source/_static/demo/ from the
committed fixture casts: it runs stage 2 and QC in a temporary folder, recompiles
tests/fixtures/profiles_demo.nc (a committed fixture the tests read), and builds the report.
The maps get bathymetry from ../cruiseplan/data/bathymetry/GEBCO_2025.nc when that file
exists. Run it from the repository root after a change to the report pages, and commit both:
python scripts/make_demo.py
ctdcast run config_demo.yaml --stage profiles builds a report from the same casts into
demo_report/ (the compiled file in demo_work/), without stage 2 or QC.