nuctransportdb.export_data
==========================

.. py:module:: nuctransportdb.export_data


Attributes
----------

.. autoapisummary::

   nuctransportdb.export_data.REQUIRED_FIELDS


Functions
---------

.. autoapisummary::

   nuctransportdb.export_data.load_all_emitted_energy
   nuctransportdb.export_data.load_all_species_type_data
   nuctransportdb.export_data.export_species_data
   nuctransportdb.export_data.export_nuclide_emitted_energy
   nuctransportdb.export_data.export_sorption_data_for_site
   nuctransportdb.export_data.parse_args
   nuctransportdb.export_data.load_nuclide_yaml_config
   nuctransportdb.export_data.validate_config
   nuctransportdb.export_data.build_nuclide_config
   nuctransportdb.export_data.main


Module Contents
---------------

.. py:function:: load_all_emitted_energy()

.. py:function:: load_all_species_type_data()

.. py:function:: export_species_data(input_config) -> None

.. py:function:: export_nuclide_emitted_energy(input_config) -> None

.. py:function:: export_sorption_data_for_site(input_config) -> None

.. py:data:: REQUIRED_FIELDS
   :value: ['nuclide_to_consider']


.. py:function:: parse_args()

.. py:function:: load_nuclide_yaml_config(config_path)

   Load a YAML configuration file.

   :param config_path: Path to the input YAML configuration file
   :type config_path: str

   :raises FileNotFoundError: not found message.
   :raises ValueError: empty config file message.

   :returns: configuration dictionary.
   :rtype: dict


.. py:function:: validate_config(config) -> None

   Validate that all required fields are present in the config.

   :param config: configuration dictionary
   :type config: dict

   :raises ValueError: missing required field message.


.. py:function:: 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)

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

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

   :returns: configuration dictionary with output paths given via CLI.
   :rtype: dict


.. py:function:: main() -> None