nuctransportdb.export_data

Attributes

REQUIRED_FIELDS

Functions

`load_all_emitted_energy`()
`load_all_species_type_data`()
`export_species_data`(→ None)
`export_nuclide_emitted_energy`(→ None)
`export_sorption_data_for_site`(→ None)
`parse_args`()
`load_nuclide_yaml_config`(config_path)	Load a YAML configuration file.
`validate_config`(→ None)	Validate that all required fields are present in the config.
`build_nuclide_config`(config_path, path_to_site_yaml, ...)	Load and validate, a site configuration file. Save rock, site, geometry data with output paths given via CLI.
`main`(→ None)

Module Contents

nuctransportdb.export_data.load_all_emitted_energy()[source]

nuctransportdb.export_data.load_all_species_type_data()[source]

nuctransportdb.export_data.export_species_data(input_config) → None[source]

nuctransportdb.export_data.export_nuclide_emitted_energy(input_config) → None[source]

nuctransportdb.export_data.export_sorption_data_for_site(input_config) → None[source]

nuctransportdb.export_data.REQUIRED_FIELDS = ['nuclide_to_consider'][source]

nuctransportdb.export_data.parse_args()[source]

nuctransportdb.export_data.load_nuclide_yaml_config(config_path)[source]

Load a YAML configuration file.

Parameters:

config_path (str) – Path to the input YAML configuration file

Raises:

FileNotFoundError – not found message.
ValueError – empty config file message.

Returns:

configuration dictionary.

Return type:

dict

nuctransportdb.export_data.validate_config(config) → None[source]

Validate that all required fields are present in the config.

Parameters:: config (dict) – configuration dictionary
Raises:: ValueError – missing required field message.

nuctransportdb.export_data.build_nuclide_config(config_path, path_to_site_yaml, path_to_save_sorption_data, path_to_save_nuclide_species_data, path_to_save_nuclide_emitted_energy_data)[source]

Load and validate, a site configuration file. Save rock, site, geometry data with output paths given via CLI.

Parameters:

config_path (str) – path to the configuration file.
path_to_site_yaml (str) – Path to a site YAML file.
path_to_save_sorption_data (str) – Output directory for sorption coefficient data.
path_to_save_nuclide_species_data (str) – Output directory for nuclide species data.
path_to_save_nuclide_emitted_energy_data (str) – Output directory for emitted energy data.

Returns:

configuration dictionary with output paths given via CLI.

Return type:

dict

nuctransportdb.export_data.main() → None[source]