Tutorial API

Public API for copying the bundled tutorial notebook.

pstrain.api.tutorial.copy_tutorial(output='arctic_hmm_gmm_tutorial.ipynb', *, force=False, dry_run=False)

Copy the bundled tutorial notebook to output.

If output is an existing directory, the standard tutorial filename is appended. Existing files are protected unless force is true.

Parameters:

• output (str | Path)

• force (bool)

• dry_run (bool)

Return type:

TutorialResult

The package root also exports pstrain.api.TutorialExistsError, pstrain.api.TutorialResult, and pstrain.api.copy_tutorial().

pstrain.api.tutorial.TUTORIAL_FILENAME

Filename used when copying the bundled tutorial notebook.