wf_psf.utils.io module

IO.

A module which defines methods to manage wf-psf inputs and outputs.

Author:

Jennifer Pollack <jennifer.pollack@cea.fr>

class wf_psf.utils.io.FileIOHandler(repodir_path, output_path, config_path)

Bases: object

FileIOHandler.

A class to manage the output file structure.

Parameters:

• repodir_path (str) – Absolute path to the code repository directory

• output_path (str) – Absolute path to output directory

Methods

copy_conffile_to_output_dir(source_file)	Write File.
get_checkpoint_dir(checkpoint_dir)	Get Checkpoint Directory.
get_config_dir(run_output_dir)	Get Config Directory.
get_metrics_dir(metrics_dir)	Get Metrics Directory.
get_optimizer_dir(optimizer_dir)	Get Optimizer Directory.
get_plots_dir(plots_dir)	Get Plots Directory.
get_psf_model_dir(psf_model_dir)	Get PSF Model Directory.
get_timestamp()	Get Timestamp.
setup_outputs()	Setup Outputs.

copy_conffile_to_output_dir(source_file)

Write File.

A function to copy a file to the output run directory.

Parameters:

• source_dir (str) – Location of source file

• source_file (str) – Name of source file

get_checkpoint_dir(checkpoint_dir)

Get Checkpoint Directory.

A function that returns path of checkpoint directory.

Parameters:

checkpoint_dir (str) – Name of checkpoint directory

Returns:

Absolute path to checkpoint directory

Return type:

str

get_config_dir(run_output_dir)

Get Config Directory.

A function that returns path of config directory.

Returns:

Absolute path to config directory

Return type:

str

get_metrics_dir(metrics_dir)

Get Metrics Directory.

A function that returns path of metrics directory.

Parameters:

metrics_dir (str) – Name of metrics directory

Returns:

Absolute path to metrics directory

Return type:

str

get_optimizer_dir(optimizer_dir)

Get Optimizer Directory.

A function that returns path of optimizer directory.

Parameters:

optimizer_dir (str) – Name of optimiser directory

Returns:

Absolute path to optimizer directory

Return type:

str

get_plots_dir(plots_dir)

Get Plots Directory.

A function that returns path of plots directory.

Parameters:

plots_dir (str) – Name of plots directory

Returns:

Absolute path to plots directory

Return type:

str

get_psf_model_dir(psf_model_dir)

Get PSF Model Directory.

A function that returns path of PSF model directory.

Parameters:

psf_model_dir (str) – Name of psf model directory

Returns:

Absolute path to psf model directory

Return type:

str

get_timestamp()

Get Timestamp.

A function to return the date and time.

Returns:

timestamp – A string representation of the date and time.

Return type:

str

setup_outputs()

Setup Outputs.

A function to call specific functions to set up output directories and logging.

Parameters:

output_path (str) – Path to output directory