Skip to content

dataset

tergite_autocalibration.utils.io.dataset

Functions:

Name Description
create_node_data_path

Create the folder where measurement results, plots and logs specific to the node are stored.

save_dataset

Save the measurement dataset to a file.

scrape_and_copy_hdf5_files

Find all measurement result files and copy them to the target directory.

create_node_data_path

create_node_data_path(node_name: str) -> Path

Create the folder where measurement results, plots and logs specific to the node are stored.

Parameters:

Name Type Description Default
node_name str

to create a data path for.

required

Returns:

Type Description
Path

Path to the measurement log folder as Path.

save_dataset

save_dataset(result_dataset: Dataset, node_name: str, data_path: Path) -> None

Save the measurement dataset to a file.

Parameters:

Name Type Description Default
result_dataset Dataset

The dataset to save.

required
node_name str

Name of the node being measured.

required
data_path Path

Path where the dataset will be saved.

required

scrape_and_copy_hdf5_files

scrape_and_copy_hdf5_files(scrape_directory: Union[Path, str], target_directory: Union[Path, str])

Find all measurement result files and copy them to the target directory.

Parameters:

Name Type Description Default
scrape_directory Union[Path, str]

Folder with measurement result files.

required
target_directory Union[Path, str]

Target directory to copy files to.

required