zarr_local_storage
Classes:
Name | Description |
---|---|
ZarrLocalStorage |
Handles data storage and retrieval for zarr archives on a local filesystem. |
Classes#
ZarrLocalStorage #
Bases: FileSystem
Handles data storage and retrieval for zarr archives on a local filesystem.
Zarr is a special format that writes chunked data to a number of files underneath a given directory. This distribution of data into chunks and distinct files makes zarr an extremely well-suited format for quickly storing and retrieving large quantities of data.
Classes:
Name | Description |
---|---|
Parameters |
|
Methods:
Name | Description |
---|---|
last_modified |
|
modified_since |
|
Attributes:
Name | Type | Description |
---|---|---|
handler |
ZarrHandler
|
The ZarrHandler class that should be used to handle data I/O within the storage |
parameters |
Parameters
|
File-system specific parameters, such as the root path to where the Z arr |
Attributes#
handler
class-attribute
instance-attribute
#
The ZarrHandler class that should be used to handle data I/O within the storage API.
parameters
class-attribute
instance-attribute
#
File-system specific parameters, such as the root path to where the Z arr archives should be saved, or additional keyword arguments to specific functions used by the storage API. See the Parameters class for more details.
Classes#
Parameters #
Bases: Parameters
Attributes:
Name | Type | Description |
---|---|---|
data_filename_template |
str
|
Template string to use for data filenames. |
data_storage_path |
Path
|
The directory structure under storage_root where ancillary files are saved. |
Attributes#
class-attribute
instance-attribute
#Template string to use for data filenames.
Allows substitution of the following parameters using curly braces '{}':
ext
: the file extension from the storage data handlerdatastream
from the dataset's global attributeslocation_id
from the dataset's global attributesdata_level
from the dataset's global attributes- Any other global attribute that has a string or integer data type.
class-attribute
instance-attribute
#The directory structure under storage_root where ancillary files are saved.
Allows substitution of the following parameters using curly braces '{}':
storage_root
: the value from thestorage_root
parameter.datastream
: thedatastream
as defined in the dataset config file.location_id
: thelocation_id
as defined in the dataset config file.data_level
: thedata_level
as defined in the dataset config file.year
: the year of the first timestamp in the file.month
: the month of the first timestamp in the file.day
: the day of the first timestamp in the file.extension
: the file extension used by the output file writer.