bluemath_tk.config package

Submodules

bluemath_tk.config.paths module

bluemath_tk.config.paths.get_catalog_folders() → Dict[str, str][source]

Get a dictionary of folder names and their links from the first level of the catalog.

Returns:: Dictionary with folder names as keys and their catalog URLs as values.
Return type:: Dict[str, str]

bluemath_tk.config.paths.get_paths(verbose: bool = True) → dict[source]

Get the paths dictionary.

Parameters:: verbose (bool, optional) – Whether to print warnings about Thredds paths. Default is True.
Returns:: Dictionary containing the paths.
Return type:: dict

bluemath_tk.config.paths.get_thredds_catalog() → TDSCatalog[source]

Get the Thredds catalog object.

Returns:: Siphon TDSCatalog object containing the catalog information.
Return type:: TDSCatalog

bluemath_tk.config.paths.print_catalog_table() → None[source]: Print a formatted table of available folders in the catalog.

bluemath_tk.config.paths.update_paths(new_paths: dict) → None[source]

Update the paths dictionary with new values.

Parameters:: new_paths (dict) – Dictionary containing new path values to update.

Examples

>>> update_paths({"MY_PATH": "/new/path/to/data"})

Module contents

Project: BlueMath_tk Sub-Module: config Author: GeoOcean Research Group, Universidad de Cantabria Repository: https://github.com/GeoOcean/BlueMath_tk.git Status: Under development (Working)