open_dataset

Contents

open_dataset#

opacity.open_dataset(species, cache=True, cache_path=None, fsspec_filesystem=None, local_cache_store=None, max_cache_size_gb=20.0)[source]#

Open an Dataset for species, and optionally cache downloads.

Parameters:

  • species (str) – Name of the atom or molecule

  • cache (bool, optional) – On retrieving (all, or parts of) a remote array cache the result locally. Default is True,

  • cache_path (str or None, optional) – If specified and cache=True, the dataset will be cached in a zarr array located at cache_path. Default is None.

  • fsspec_filesystem (filesystem, optional) – Remote filesystem, with or without signed requests. Default is None.

  • local_cache_store (LocalStore, optional) – User-defined local Zarr cache store. Default is None.

  • max_cache_size_gb (float, optional) – Maximum Zarr array size cached in local memory. Default is 20.

Returns:

Opacity Dataset.

Return type:

Dataset

Raises:

ValueError – If species is None.

Contents