yieldplotlib.load#

High-level loaders for yieldplotlib.

Submodules#

Classes#

`AYODirectory`	Loader for AYO directories.
`DRMDirectory`	Loader for DRM data, organizing files into a directory-based structure.
`EXOSIMSCSVDirectory`	Loader for CSV data, organizing files into a directory-based structure.
`EXOSIMSDirectory`	Loader for EXOSIMS data, organizing files into a directory-based structure.
`SPCDirectory`	Loader for SPC data, organizing files into a directory-based structure.
`YIPDirectory`	Loader for YIPs, organizing files into a directory-based structure.

Package Contents#

class yieldplotlib.load.AYODirectory(directory_path)[source]#

Bases: yieldplotlib.core.directory_node.DirectoryNode

Loader for AYO directories.

Currently only supports CSV files.

Parameters:: directory_path (pathlib.Path)

_create_file_node(path)[source]#

Override file node creation logic for AYO-specific files.

Parameters:: path (pathlib.Path)
Return type:: yieldplotlib.core.node.Node

class yieldplotlib.load.DRMDirectory(root_directory)[source]#

Bases: EXOSIMSDirectory

Loader for DRM data, organizing files into a directory-based structure.

Parameters:: root_directory (pathlib.Path)

_create_file_node(path)[source]#

Override file node creation logic for DRM-specific files.

Parameters:: path (pathlib.Path)

class yieldplotlib.load.EXOSIMSCSVDirectory(root_directory)[source]#

Bases: EXOSIMSDirectory

Loader for CSV data, organizing files into a directory-based structure.

Parameters:: root_directory (pathlib.Path)

_create_file_node(path)[source]#

Override file node creation logic for CSV-specific files.

Parameters:: path (pathlib.Path)

class yieldplotlib.load.EXOSIMSDirectory(root_directory)[source]#

Bases: yieldplotlib.core.DirectoryNode

Loader for EXOSIMS data, organizing files into a directory-based structure.

Parameters:: root_directory (pathlib.Path)

_create_directory_node(path)[source]#

Override directory node creation logic for EXOSIMS-specific directories.

Parameters:: path (pathlib.Path)
Return type:: yieldplotlib.core.Node

_create_file_node(path)[source]#

Override file node creation logic for EXOSIMS-specific files.

Parameters:: path (pathlib.Path)
Return type:: yieldplotlib.core.Node

class yieldplotlib.load.SPCDirectory(root_directory)[source]#

Bases: EXOSIMSDirectory

Loader for SPC data, organizing files into a directory-based structure.

Parameters:: root_directory (pathlib.Path)

_create_file_node(path)[source]#

Override file node creation logic for SPC-specific files.

Parameters:: path (pathlib.Path)

class yieldplotlib.load.YIPDirectory(root_directory)[source]#

Bases: yieldplotlib.core.DirectoryNode

Loader for YIPs, organizing files into a directory-based structure.

Parameters:: root_directory (pathlib.Path)

coronagraph#

_create_directory_node(path)[source]#

Override directory node creation logic for YIP-specific directories.

Parameters:: path (pathlib.Path)
Return type:: yieldplotlib.core.Node

_create_file_node(path)[source]#

Override file node creation logic for YIP-specific files.

Parameters:: path (pathlib.Path)
Return type:: yieldplotlib.core.Node

get(key)[source]#

Search for a key (e.g., “data” or “D”) in the tree structure.

Parameters:: key (str)