Python API

File Compression

enstools.compression.api.compress(...[, ...])

Copies a list of files to the destination applying compression.

Analysis

enstools.compression.api.analyze_dataset(dataset)	Finds optimal compression parameters for a dataset to fulfill certain thresholds.
enstools.compression.api.analyze_files(...)	Finds optimal compression parameters for a list of files to fulfill certain thresholds.

Significant Bits

enstools.compression.api.analyze_file_significant_bits(...)

Analyzes the significant bits in each variable of a file.

Pruner

enstools.compression.api.pruner(file_paths, ...)

Apply bit prunning to a list of files.

Emulation

enstools.compression.api.emulate_compression_on_dataset(...)	Emulate the compression on an xarray dataset using the specified compression settings.
enstools.compression.api.emulate_compression_on_data_array(...)	Emulates compression on a given DataArray using the specified encoding.
enstools.compression.api.emulate_compression_on_numpy_array(...)	Emulates compression on a given NumPy array using the specified encoding.

Evaluation

enstools.compression.api.evaluate(...[, ...])

The purpose of this routine is to obtain some metrics and plots on how similar are two datasets.