boilercv_pipeline.equations.make_docs

Generate equation documentation.

Module Contents

Functions

main
watch_eqs	Watch for changes in equations.
make_docs	Generate equation documentation.
get_raw_equations	Get equations.

Data

DIR_TO_WATCH	Directory to watch.
FILTER	Files in directory to watch.
INTERVAL	Seconds to wait before checking again.
COOLDOWN	Wait at least this many seconds before triggering on_modified again.
OUT	Generated equations directory.
APP	CLI.
SEP	Line separator.

API

boilercv_pipeline.equations.make_docs.DIR_TO_WATCH

None

Directory to watch.

boilercv_pipeline.equations.make_docs.FILTER

None

Files in directory to watch.

boilercv_pipeline.equations.make_docs.INTERVAL

5

Seconds to wait before checking again.

boilercv_pipeline.equations.make_docs.COOLDOWN

2

Wait at least this many seconds before triggering on_modified again.

boilercv_pipeline.equations.make_docs.OUT

None

Generated equations directory.

boilercv_pipeline.equations.make_docs.APP

‘App(…)’

CLI.

boilercv_pipeline.equations.make_docs.SEP

‘ ‘

Line separator.

async boilercv_pipeline.equations.make_docs.main()

async boilercv_pipeline.equations.make_docs.watch_eqs(

corr: boilercv.correlations.types.Corr | boilercv.correlations.types.Range,

)

Watch for changes in equations.

boilercv_pipeline.equations.make_docs.make_docs()

Generate equation documentation.

boilercv_pipeline.equations.make_docs.get_raw_equations(

corr: boilercv.correlations.types.Corr | boilercv.correlations.types.Range,

) → dict[boilercv.correlations.types.Equation, str]

Get equations.