nomad_camels_toolbox package

Submodules

nomad_camels_toolbox.data_reader module

nomad_camels_toolbox.data_reader.read_camels_file(file_path, data_set_key: str = '', entry_key: str = '', return_dataframe: bool = True, read_variables: bool = True, return_fits: bool = False)

Read data from a CAMELS file.

Parameters:

  • file_path (str) – Path to the CAMELS file.

  • data_set_key (str, optional (default: "")) – Key of the data set to read. If not specified, the main data set is read.

  • entry_key (str, optional (default: "")) – Key of the entry to read. If not specified and there is more than one entry, the user is asked to select one.

  • return_dataframe (bool, optional (default: True)) – Whether to return the data as a pandas DataFrame. Requires pandas to be installed if pandas is not installed, this parameter is ignored.

  • read_variables (bool, optional (default: True)) – Whether to read the variables from the data set.

  • return_fits (bool, optional (default: False)) – Whether to return the fits of the data set.

Returns:

  • data (dict or pd.DataFrame) – The data from the data set.

  • fit_dict (dict) – The fits of the data set, only returned if return_fits is True.

Module contents