Skip to content

Commit

Permalink
Updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
agstephens committed Apr 3, 2020
1 parent 59f7718 commit 49859bd
Showing 1 changed file with 16 additions and 6 deletions.
22 changes: 16 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,35 @@
# clisops

# clisops - climate simulation operations

[![Pypi](https://img.shields.io/pypi/v/clisops.svg)](https://pypi.python.org/pypi/clisops)

[![Travis](https://img.shields.io/travis/ellesmith88/clisops.svg)](https://travis-ci.org/ellesmith88/clisops)

[![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.


## Features

* TODO
The package provides the following operations:
* subset
* average
* regrid

# Credits

Expand Down

0 comments on commit 49859bd

Please sign in to comment.