open_edataset

open_edataset(remote_conn, file_path, flag='r', dataset_type='grid', compression='zstd', compression_level=1, num_groups=None, **kwargs)

Open a cfdb that is linked with a remote S3 database.

Parameters:

Name	Type	Description	Default
remote_conn	S3Connection, str, or dict	The object to connect to a remote. It can be an S3Connection object, an http url string, or a dict with the parameters for initializing an S3Connection object.	required
file_path	str or Path	It must be a path to a local file location. If you want to use a tempfile, then use the name from the NamedTemporaryFile initialized class.	required
flag	str	Flag associated with how the file is opened according to the dbm style. 'r' -- Open existing database for reading only (default). 'w' -- Open existing database for reading and writing. 'c' -- Open database for reading and writing, creating it if it doesn't exist. 'n' -- Always create a new, empty database, open for reading and writing.	'r'
dataset_type	str	The dataset type to be opened. Default is 'grid'. 'grid' -- The standard CF conventions dimensions/coordinates. Each coordinate must be unique and increasing in ascending order. Each coordinate represents a single axis (i.e. x, y, z, t). The z axis is currently optional. 'ts_ortho' -- A special time series coordinate structure representing the orthogonal multidimensional array representation of time series. Designed for time series data with sparse geometries (e.g. station time series data). The Geometry dtype must represent the xy axis. The z axis is currently optional.	'grid'
compression	str	The compression algorithm used for compressing all data. Must be either 'zstd' or 'lz4'. zstd has a good balance of compression ratio to speed, while lz4 emphasises speed. Default is 'zstd'.	'zstd'
compression_level	int or None	The compression level used by the compression algorithm. Setting this to None will use the defaults, which is 1 for both compression options.	1
num_groups	int or None	The number of groups for grouped S3 object storage. Required when creating a new database (flag='n'). For existing databases, this value is read from S3 metadata and the user-provided value is ignored.	None
**kwargs		Any kwargs that can be passed to ebooklet.open_ebooklet.	{}

Returns:

Type	Description
EDataset