Datastore Builders

The same Python package that includes the ACCESS-NRI catalog, access-nri-intake, also includes a set of Intake-ESM datastore Builders for different ACCESS model outputs. In general, building an Intake-ESM datastore for your ACCESS model output should be as simple as passing your output base directory to an appropriate Builder.

The access-nri-intake package is installed in the xp65 analysis environment, or users can install it into their own environment (see Installing the catalog for details). The Builders can be imported from the access_nri_intake.source.builders submodule.

There are currently four Builders available. Their core public APIs are given below (their full APIs can be found in API for access_nri_intake.source).

Note

These Builders are used by ACCESS-NRI to create the ACCESS-NRI catalog.

ACCESS-OM2 output: AccessOm2Builder

class access_nri_intake.source.builders.AccessOm2Builder(paths, storage_options=None, depth=0, exclude_patterns=None, include_patterns=None, joblib_parallel_kwargs=None)

Intake-ESM datastore builder for ACCESS-OM2 COSIMA datasets

Methods

build()	Builds a datastore from a list of netCDF files or zarr stores.
save(name, description[, directory])	Save datastore contents to a file.

__init__(path, **kwargs)

Initialise a AccessOm2Builder

Parameters:

pathstr or list of str

Path or list of paths to crawl for assets/files.

build()

Builds a datastore from a list of netCDF files or zarr stores.

save(name, description, directory=None)

Save datastore contents to a file.

Parameters:

name: str

The name of the file to save the datastore to.

descriptionstr

Detailed multi-line description of the collection.

directory: str, optional

The directory to save the datastore to. If None, use the current directory.

ACCESS-ESM1.5 output: AccessEsm15Builder

class access_nri_intake.source.builders.AccessEsm15Builder(paths, storage_options=None, depth=0, exclude_patterns=None, include_patterns=None, joblib_parallel_kwargs=None)

Intake-ESM datastore builder for ACCESS-ESM1.5 datasets

Methods

build()	Builds a datastore from a list of netCDF files or zarr stores.
save(name, description[, directory])	Save datastore contents to a file.

__init__(path, ensemble, **kwargs)

Initialise a AccessEsm15Builder

Parameters:

path: str or list of str

Path or list of paths to crawl for assets/files.

ensemble: boolean

Whether to treat each path as a separate member of an ensemble to join along a new member dimension

build()

Builds a datastore from a list of netCDF files or zarr stores.

save(name, description, directory=None)

Save datastore contents to a file.

Parameters:

name: str

The name of the file to save the datastore to.

descriptionstr

Detailed multi-line description of the collection.

directory: str, optional

The directory to save the datastore to. If None, use the current directory.

ACCESS-CM2 output: AccessCm2Builder

class access_nri_intake.source.builders.AccessCm2Builder(paths, storage_options=None, depth=0, exclude_patterns=None, include_patterns=None, joblib_parallel_kwargs=None)

Intake-ESM datastore builder for ACCESS-CM2 datasets

Methods

build()	Builds a datastore from a list of netCDF files or zarr stores.
save(name, description[, directory])	Save datastore contents to a file.

__init__(path, ensemble, **kwargs)

Initialise a AccessEsm15Builder

Parameters:

path: str or list of str

Path or list of paths to crawl for assets/files.

ensemble: boolean

Whether to treat each path as a separate member of an ensemble to join along a new member dimension

build()

Builds a datastore from a list of netCDF files or zarr stores.

save(name, description, directory=None)

Save datastore contents to a file.

Parameters:

name: str

The name of the file to save the datastore to.

descriptionstr

Detailed multi-line description of the collection.

directory: str, optional

The directory to save the datastore to. If None, use the current directory.

ACCESS-OM3 output: AccessOm3Builder

class access_nri_intake.source.builders.AccessOm3Builder(paths, storage_options=None, depth=0, exclude_patterns=None, include_patterns=None, joblib_parallel_kwargs=None)

Intake-ESM datastore builder for ACCESS-OM3 COSIMA datasets

Methods

build()	Builds a datastore from a list of netCDF files or zarr stores.
save(name, description[, directory])	Save datastore contents to a file.

__init__(path, **kwargs)

Initialise a AccessOm3Builder

Parameters:

pathstr or list of str

Path or list of paths to crawl for assets/files.

build()

Builds a datastore from a list of netCDF files or zarr stores.

save(name, description, directory=None)

Save datastore contents to a file.

Parameters:

name: str

The name of the file to save the datastore to.

descriptionstr

Detailed multi-line description of the collection.

directory: str, optional

The directory to save the datastore to. If None, use the current directory.

Note

If you have ACCESS model output that isn’t compatible with the existing set of Builders, check out the Creating a new Builder section or open an issue here.