braincell.io.load_branch

braincell.io.load_branch(path)

Load a Branch from a braincell checkpoint file.

Parameters:

path (str | PathLike) – Path to a .bcm checkpoint produced by save_branch().

Returns:

The reconstructed branch as the appropriate typed subclass (e.g. Soma, Dendrite).

Return type:

Branch

Raises:

• CheckpointError – If the file is missing, not a braincell checkpoint, corrupt, or is a morphology checkpoint instead of a branch checkpoint.

• CheckpointVersionError – If the checkpoint version is newer than this build supports.

See also

save_branch

Inverse operation.

load_morpho

Load a whole morphology tree.