From 49859bd286d755619cb891e5079188a736344a50 Mon Sep 17 00:00:00 2001 From: Ag Stephens Date: Fri, 3 Apr 2020 08:26:12 +0000 Subject: [PATCH] Updated README --- README.md | 22 ++++++++++++++++------ 1 file changed, 16 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 1d61dbf3..21793e80 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,4 @@ -# clisops - +# clisops - climate simulation operations [![Pypi](https://img.shields.io/pypi/v/clisops.svg)](https://pypi.python.org/pypi/clisops) @@ -7,11 +6,19 @@ [![Documentation](https://readthedocs.org/projects/clisops/badge/?version=latest)](https://clisops.readthedocs.io/en/latest/?badge=latest) +The `clisops` package (pronounced "clie-sops") provides a python library for running +_data-reduction_ operations on [Xarray](http://xarray.pydata.org/) data sets or files +that can be interpreted by Xarray. These basic operations (subsetting, averaging and +regridding) are likely to work where data structures are NetCDF-centric, such as those +found in ESGF data sets. +`clisops` is employed by the [daops](https://github.com/roocs/daops) library to perform +its basic operations once `daops` has applied any necessary _fixes_ to data in order +to remove irregularities/anomalies. Users are recommended to investigate using `daops` +directly in order to access these _fixes_ which may affect the scientific credibility of +the results. - -A short description goes here - +`clisops` can be used stand-alone to read individual, or groups of, NetCDF files directly. * Free software: BSD * Documentation: https://clisops.readthedocs.io. @@ -19,7 +26,10 @@ A short description goes here ## Features -* TODO +The package provides the following operations: + * subset + * average + * regrid # Credits