csiro-coasts / emsarray

xarray extension that supports EMS model formats
BSD 3-Clause "New" or "Revised" License
13 stars 2 forks source link

Rename `Format` to `Convention` #46

Closed mx-moth closed 1 year ago

mx-moth commented 1 year ago

'Format' never sat right with me. It conflicts with the format() built in. File format implies a difference like NetCDF4 vs. GRIB vs. Zarr, not the geometry conventions used within a NetCDF4 file. A NetCDF4 file does not use the CF Metadata Convention format, it uses the CF Metadata Conventions.

Convention is a better name that more accurately reflects its purpose.

All usages have been renamed. A backwards compatible import has been added, and Format implementations added to emsarray.formats entrypoint are still used. All the backwards compatible layers emit deprecation warnings if used.