studies.capture.register_study

studies.capture.register_study(study)

Add a study to the active :func:capture_studies context, if any.

The registration hook the study classes call from __post_init__. Outside a capture context this does nothing, which is what makes a study usable from a plain script.

Parameters

Name Type Description Default
study Any Any object with a name and a describe(). required