From f0ee76cd919c158754fdd98b7022eda806a3f29a Mon Sep 17 00:00:00 2001 From: JiaweiZhuang Date: Sun, 31 Dec 2017 20:18:35 -0500 Subject: [PATCH] Add basic introduction to README --- README.rst | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/README.rst b/README.rst index 901a1b6..dc986d7 100644 --- a/README.rst +++ b/README.rst @@ -3,6 +3,19 @@ xESMF: Universal Regridder for Geospatial Data |Build Status| |codecov| |docs| |license| +xESMF is a Python package for +`regridding `_. +It is + +- **Powerful**: It uses ESMF_/ESMPy_ as backend and can regrid between **general curvilinear grids** + with all `ESMF regridding algorithms `_, + such as **bilinear**, **conservative** and **nearest neighbour**. +- **Easy-to-use**: It abstracts away ESMF's complicated infrastructure + and provides a simple, high-level API, compatible with xarray_ as well as basic numpy arrays. +- **Fast**: It is faster than ESMPy's original Fortran regridding engine, + due to the use of the highly-optimized + `Scipy sparse matrix library `_. + Please see `online documentation `_. .. |Build Status| image:: https://api.travis-ci.org/JiaweiZhuang/xESMF.svg