ebm.cmd.initialize module
Module for setting up input, output and managing default data
- create_input(file_handler: FileHandler, source_directory: Path | None = None) bool[source]
Create any input file missing in file_handler.input_directory using the default data source.
Parameters
source_directory : file_handler : FileHandler
Returns
bool
- copy_available_calibration_files(file_handler: FileHandler, source_directory: Path)[source]
Copies calibration file from source to file_handler
Parameters
source_directory : pathlib.Path file_handler : FileHandler
Returns
None
- create_output_directory(output_directory: Path | None = None, filename: Path | None = None) Path[source]
Creates the output directory if it does not exist. If a filename is supplied its parent will be created.
Parameters
- output_directorypathlib.Path, optional
The path to the output directory.
- filenamepathlib.Path, optional
The name of a file in a directory expected to exist.
Raises
- IOError
The output_directory exists, but it is a file.
- ValueError
output_directory and filename is empty
Returns
- pathlib.Path
The directory
- init(file_handler: FileHandler, source_directory: Path | None = None) Path[source]
Initialize file_handler with input data from ebm.data or DEFAULT_INPUT_OVERRIDE. Create output directory in current working directory if missing
Parameters
file_handler : FileHandler source_directory : pathlib.Path, optional
Where location of input data
Returns
pathlib.Path