enstools.compression.api.analyze_files

enstools.compression.api.analyze_files(file_paths: Path | List[Path], output_file: Path | None = None, constrains: str = 'correlation_I:5,ssim_I:2', file_format: str = 'yaml', compressor: str | None = None, mode: str | None = None, grid: str | None = None, fill_na: float | bool = False, variables: List | None = None)

Finds optimal compression parameters for a list of files to fulfill certain thresholds. If an output_file argument is provided it will output the dictionary in there (yaml or json allowed).

Parameters:
  • file_paths

  • output_file

  • constrains

  • file_format

  • compressor

  • mode

  • grid

  • fill_na

  • variables

Returns: