dctools.data.datasets.dataset.RemoteDataset

class dctools.data.datasets.dataset.RemoteDataset(config)

Generic dataset for remote sources.

Parameters:

config (DatasetConfig)

__init__(config)

Initializes a dataset with a configuration.

Parameters:

config (DatasetConfig) – Dataset configuration.

Methods

__init__(config)

Initializes a dataset with a configuration.

build_catalog()

Builds a catalog for this dataset.

catalog_is_empty()

Checks if the catalog is empty.

download(index, local_path)

Download a file from the remote source.

filter_catalog_by_date(start, end)

Filters the catalog by time range.

filter_catalog_by_region(region)

Filters the catalog by bounding box.

filter_catalog_by_variable(variables)

Filters the catalog by specified variables.

get_catalog()

Returns the dataset catalog.

get_connection_config()

Get the connection configuration parameters.

get_connection_manager()

Returns the ConnectionManager instance associated with the dataset.

get_coord_system()

Returns the coordinate system of the dataset.

get_eval_variables()

Return the list of standard evaluation variables.

get_global_metadata()

Returns the global metadata of the dataset.

get_metadata()

Returns the metadata of the dataset files.

get_path(index)

Returns the path of a file at a given index.

iter_data()

Iterates over the dataset files and loads them as Xarray datasets.

list_paths()

Returns the list of file paths in the dataset.

load_data(index)

Loads a dataset from a path.

standardize_names(coord_rename_dict, ...)

Standardize coordinate and variable names using rename dictionaries.

to_json(path)

Exports the entire BaseDataset content to JSON format.

download(index, local_path)

Download a file from the remote source.

Parameters:
  • index (int) – Index of the file to download.

  • local_path (str) – Path to save the downloaded file locally.