diff --git a/README.md b/README.md index 4759565b2acf84010c2b230b692fcc4c11beb70b..75ec439c9aeaf79c22898ddea4dea01b5d75dd49 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,10 @@ # Compressor that uses h5netcdf and hdf5plugin to compress files. +To use the compressor: + ```python from h5netcdfcompressor import transfer_file -transfer_file(origin, destination, compression) +compress_file(origin="original.nc", destination="compressed.nc", compression="lossy,sz,rel,1e-6") ``` diff --git a/h5netcdfcompressor/__init__.py b/h5netcdfcompressor/__init__.py index e69de29bb2d1d6434b8b29ae775ad8c2e48c5391..7c68a7f20bdcb89cbc08a658a4192a284dadb4e9 100644 --- a/h5netcdfcompressor/__init__.py +++ b/h5netcdfcompressor/__init__.py @@ -0,0 +1 @@ +from compressor import compress_file diff --git a/h5netcdfcompressor/compressor.py b/h5netcdfcompressor/compressor.py index 92da406f58bbfde1afbbe99594e5e57aee5bd522..282b2505c19f0eea0d77fc4cd9d20465c92ef996 100644 --- a/h5netcdfcompressor/compressor.py +++ b/h5netcdfcompressor/compressor.py @@ -2,7 +2,7 @@ from pathlib import Path from typing import List -def transfer_file(origin: Path, +def compress_file(origin: Path, destination: Path, compression: str, variables_to_keep: List[str] = None,