aind_behavior_curriculum.curriculum_utils.export_diagram¶

aind_behavior_curriculum.curriculum_utils.export_diagram(curriculum: Curriculum, path: PathLike | None = None) → str[source]¶

Renders a curriculum to SVG

Parameters:

curriculum (Curriculum) – A curriculum to be rendered
path (Optional[os.PathLike], optional) – An optional path to save the SVG asset to.
provided (If not path is)
returned. (only the str representation of the SVG will be)
None. (Defaults to)

Returns:

A literal string representation of the SVG.

Return type:

str