processing.main module¶
- processing.main.run(processing_target='', path_to_configuration='processing_config.toml', procedure_fingerprint_directory='', file_type_dir='', verbose=False)[source]¶
Processes one target file using the given procedure workflow file.
- Parameters:
processing_target (str :) –
- The target file to process.
(Default value = “”)
path_to_configuration (Path | str :) –
- The path to the configuration file.
(Default value = Path(“processing_config.toml”))
procedure_fingerprint_directory (str | None :) –
The path to a fingerprint directory. If none given, no fingerprints will be created.
(Default value = None)
file_type_dir (str | None :) –
The path to a file type directory. If none given, the files will not be separated into file type directories.
(Default value = None)
verbose (bool :) –
- An option to allow more verbose output.
(Default value = False)
- processing.main.convert(input_dir, psa_path, output_dir='', xmlcon_dir='', pattern='')[source]¶
Converts a list of Sea-Bird raw data files (.hex) to .cnv files.
Does either use an explicit list of paths or searches for all .hex files in the given directory.
- Parameters:
input_dir (Path | str :) – The data directory with the target .hex files.
psa_path (Path | str :) – The path to the .psa for datcnv.
output_dir (Path | str :) – The directory to store the converted .cnv files in. (Default is the input directory)
xmlcon_dir (Path | str :) – The directory to look for .xmlcon files. (Default is the input directory)
pattern (str :) – A name pattern to filter the target .hex files with. (Default is none)
- Return type:
A list of paths or CnvFiles of the converted files.
- processing.main.batch(input_dir, config, pattern='.cnv')[source]¶
Applies a processing config to multiple .hex or. cnv files.
- Parameters:
input_dir (Path | str :) – The data directory with the target files.
config (dict | Path | str:) – Either an explicit config as dict or a path to a .toml config file.
pattern (str :) – A name pattern to filter the target files with. (Default is “.cnv”)
- Return type:
A list of paths or CnvFiles of the processed files.