bgc_data_processing.core.io.savers

Save Storers to a file.

StorerSaver(storer, save_aggregated_data_only=False)

Saver for Storer objects.

Parameters:

Name	Type	Description	Default
storer	Storer	Storer to save.	required
save_aggregated_data_only	bool	Whether to only save the aggregated data or not. If False, for every provider, a folder with the providers' data will be created.	False

Source code in src/bgc_data_processing/core/io/savers.py

def __init__(
    self,
    storer: "Storer",
    save_aggregated_data_only: bool = False,
) -> None:
    self._storer = storer
    self._variables = copy(storer.variables.saving_variables)
    self.save_aggregated_data_only = save_aggregated_data_only

single_filename_format: str = 'nutrients_{provider}_{dates}.txt' class-attribute instance-attribute

aggr_filename_format: str = 'bgc_{category}_{dates}.txt' class-attribute instance-attribute

save_aggregated_data_only = save_aggregated_data_only instance-attribute

saving_order: list[str] property writable

Saving Order for variables.

save_from_daterange(dateranges_gen, saving_directory)

Save the storer's data according to the given dateranges.

Parameters:

Name	Type	Description	Default
dateranges_gen	DateRangeGenerator	Generator to use to retrieve dateranges.	required
saving_directory	Path | str	Path to the idrectory to save in.	required

Source code in src/bgc_data_processing/core/io/savers.py

def save_from_daterange(
    self,
    dateranges_gen: "DateRangeGenerator",
    saving_directory: Path | str,
) -> None:
    """Save the storer's data according to the given dateranges.

    Parameters
    ----------
    dateranges_gen : DateRangeGenerator
        Generator to use to retrieve dateranges.
    saving_directory: Path | str
        Path to the idrectory to save in.
    """
    dateranges = dateranges_gen()
    dates_slices = self._slice_using_drng(dateranges)
    dates_slices.apply(
        self._save_slice,
        axis=1,
        saving_directory=Path(saving_directory),
    )

save_all_storer(filepath)

Save all the storer to the given file.

Parameters:

Name	Type	Description	Default
filepath	Path | str	File in which to save the storer data.	required

Raises:

Type	Description
FileExistsError	If filepath points to an existing file.

Source code in src/bgc_data_processing/core/io/savers.py

def save_all_storer(self, filepath: Path | str) -> None:
    """Save all the storer to the given file.

    Parameters
    ----------
    filepath : Path | str
        File in which to save the storer data.

    Raises
    ------
    FileExistsError
        If filepath points to an existing file.
    """
    if filepath.is_file():
        error_msg = f"A file already exist at {filepath} and can not be erased."
        raise FileExistsError(error_msg)
    self._save_data(filepath=Path(filepath), data_slice=self._storer)

save(storer, filepath, save_aggregated_data_only=False) classmethod

Save all the storer to the given file.

Parameters:

Name	Type	Description	Default
storer	Storer	Storer to save.	required
filepath	Path | str	File in which to save the storer data.	required
save_aggregated_data_only	bool	Whether to only save the aggregated data or not. If False, for every provider, a folder with the provider's data will be created.	False

Source code in src/bgc_data_processing/core/io/savers.py

@classmethod
def save(
    cls,
    storer: "Storer",
    filepath: Path | str,
    save_aggregated_data_only: bool = False,
) -> None:
    """Save all the storer to the given file.

    Parameters
    ----------
    storer : Storer
        Storer to save.
    filepath : Path | str
        File in which to save the storer data.
    save_aggregated_data_only: bool
        Whether to only save the aggregated data or not.
        If False, for every provider, a folder with the provider's
        data will be created.
    """
    saver = cls(storer=storer, save_aggregated_data_only=save_aggregated_data_only)
    saver.save_all_storer(filepath=Path(filepath))

save_storer(storer, filepath, saving_order=None, save_aggregated_data_only=True)

Save en entire Storer to a given filepath.

Parameters:

Name	Type	Description	Default
storer	Storer	Storer to save.	required
filepath	Path | str	File in which to save the storer data.	required
saving_order	list[str] | None	Variable order to respect when saving. If the list is empty , all variables are saved., by default None	None
save_aggregated_data_only	bool	Whether to only save the aggregated data or not. If False, for every provider, a folder with the provider's data will be created., by default True	True

Source code in src/bgc_data_processing/core/io/savers.py

def save_storer(
    storer: "Storer",
    filepath: Path | str,
    saving_order: list[str] | None = None,
    save_aggregated_data_only: bool = True,
) -> None:
    """Save en entire Storer to a given filepath.

    Parameters
    ----------
    storer : Storer
        Storer to save.
    filepath : Path | str
        File in which to save the storer data.
    saving_order : list[str] | None, optional
        Variable order to respect when saving. If the list is empty
        , all variables are saved., by default None
    save_aggregated_data_only : bool, optional
        Whether to only save the aggregated data or not.
        If False, for every provider, a folder with the provider's
        data will be created., by default True
    """
    saver = StorerSaver(
        storer=storer,
        save_aggregated_data_only=save_aggregated_data_only,
    )
    if saving_order is not None:
        saver.saving_order = saving_order
    saver.save_all_storer(filepath=Path(filepath))