nuctransportdb.add_default
==========================

.. py:module:: nuctransportdb.add_default


Functions
---------

.. autoapisummary::

   nuctransportdb.add_default.get_all_default_rock_types
   nuctransportdb.add_default.load_default_sorption_df
   nuctransportdb.add_default.create_empty_sorption_pd
   nuctransportdb.add_default.get_matching_default_df
   nuctransportdb.add_default.find_missing_properties
   nuctransportdb.add_default.add_default_conservative_values
   nuctransportdb.add_default.add_default_df


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

.. py:function:: get_all_default_rock_types()

   Get all available default rock types.

   :returns: a list of default rock names.
   :rtype: list


.. py:function:: load_default_sorption_df(lithologies)

   Load default rock property DataFrame for the given lithologies.

   :param lithologies: list of lithologies.
   :type lithologies: list

   :returns: Default rock property DataFrame.
   :rtype: pd.DataFrame


.. py:function:: create_empty_sorption_pd()

   Function for creating an empty sorption dataframe.

   :returns: Empty dataframe with defined columns
   :rtype: pd.DataFrame


.. py:function:: get_matching_default_df(nuclide, missing_rock_names)

   Get the matching default DataFrame for the given lithologies and missing properties.

   :param nuclide: nuclide to search for.
   :type nuclide: str
   :param missing_rock_names: list of missing properties to find defaults for.
   :type missing_rock_names: list

   :returns: DataFrame containing the matching default properties
   :rtype: pd.DataFrame


.. py:function:: find_missing_properties(property_df, lithologies)

   Find missing properties in the property DataFrame.

   :param property_df: DataFrame containing the properties to check
   :type property_df: pd.DataFrame
   :param lithologies: list of lithologies to look for default properties
   :type lithologies: list

   :returns: List of missing property names.
   :rtype: list


.. py:function:: add_default_conservative_values(nuclide, props_to_load)

   Function to add conservative estimates when no default data is available.

   :param nuclide: nuclide to search for.
   :type nuclide: str
   :param props_to_load: list of rock types.
   :type props_to_load: list

   :returns: DataFrame containing the conservative estimates.
   :rtype: pd.DataFrame


.. py:function:: add_default_df(property_df, lithologies, nuclide)

   Add default properties to the property DataFrame.

   :param property_df: DataFrame containing the properties to check.
   :type property_df: pd.DataFrame
   :param lithologies: list of lithologies to look for default properties.
   :type lithologies: list
   :param nuclide: nuclide to search for.
   :type nuclide: str

   :returns: DataFrame with default properties added
   :rtype: pd.DataFrame