revise top-level package description (#2430)

* revise main package description * Update doc/index.rst Co-Authored-By: rabernat <[email protected]> * Update doc/index.rst Co-Authored-By: rabernat <[email protected]> * Update doc/index.rst Co-Authored-By: rabernat <[email protected]> * next draft * add mention of netCDF * eliminate CDM reference * update README and setup.py * Split long paragraph, minor rewordings
pydata · Jan 6, 2019 · a0bbea8 · a0bbea8
1 parent 85f88e7
commit a0bbea8
Show file tree

Hide file tree

Showing 3 changed files with 75 additions and 33 deletions.
diff --git a/README.rst b/README.rst
@@ -18,20 +18,34 @@ xarray: N-D labeled arrays and datasets
 .. image:: https://img.shields.io/badge/powered%20by-NumFOCUS-orange.svg?style=flat&colorA=E1523D&colorB=007D8A
   :target: http://numfocus.org
 
-**xarray** (formerly **xray**) is an open source project and Python package that aims to bring the
-labeled data power of pandas_ to the physical sciences, by providing
-N-dimensional variants of the core pandas data structures.
-
-Our goal is to provide a pandas-like and pandas-compatible toolkit for
-analytics on multi-dimensional arrays, rather than the tabular data for which
-pandas excels. Our approach adopts the `Common Data Model`_ for self-
-describing scientific data in widespread use in the Earth sciences:
-``xarray.Dataset`` is an in-memory representation of a netCDF file.
-
+**xarray** (formerly **xray**) is an open source project and Python package
+that makes working with labelled multi-dimensional arrays simple,
+efficient, and fun!
+
+Multi-dimensional (a.k.a. N-dimensional, ND) arrays (sometimes called
+"tensors") are an essential part of computational science.
+They are encountered in a wide range of fields, including physics, astronomy,
+geoscience, bioinformatics, engineering, finance, and deep learning.
+In Python, NumPy_ provides the fundamental data structure and API for
+working with raw ND arrays.
+However, real-world datasets are usually more than just raw numbers;
+they have labels which encode information about how the array values map
+to locations in space, time, etc.
+
+By introducing *dimensions*, *coordinates*, and *attributes* on top of raw
+NumPy-like arrays, xarray is able to understand these labels and use them to
+provide a more intuitive, more concise, and less error-prone experience.
+Xarray also provides a large and growing library of functions for advanced
+analytics and visualization with these data structures.
+Xarray was inspired by and borrows heavily from pandas_, the popular data
+analysis package focused on labelled tabular data.
+Xarray can read and write data from most common labeled ND-array storage
+formats and is particularly tailored to working with netCDF_ files, which were
+the source of xarray's data model.
+
+.. _NumPy: http://www.numpy.org/
 .. _pandas: http://pandas.pydata.org
-.. _Common Data Model: http://www.unidata.ucar.edu/software/thredds/current/netcdf-java/CDM
 .. _netCDF: http://www.unidata.ucar.edu/software/netcdf
-.. _OPeNDAP: http://www.opendap.org/
 
 Why xarray?
 -----------

diff --git a/doc/index.rst b/doc/index.rst
@@ -2,19 +2,33 @@ xarray: N-D labeled arrays and datasets in Python
 =================================================
 
 **xarray** (formerly **xray**) is an open source project and Python package
-that aims to bring the labeled data power of pandas_ to the physical sciences,
-by providing N-dimensional variants of the core pandas data structures.
-
-Our goal is to provide a pandas-like and pandas-compatible toolkit for
-analytics on multi-dimensional arrays, rather than the tabular data for which
-pandas excels. Our approach adopts the `Common Data Model`_ for self-
-describing scientific data in widespread use in the Earth sciences:
-``xarray.Dataset`` is an in-memory representation of a netCDF file.
-
+that makes working with labelled multi-dimensional arrays simple,
+efficient, and fun!
+
+Multi-dimensional (a.k.a. N-dimensional, ND) arrays (sometimes called
+"tensors") are an essential part of computational science.
+They are encountered in a wide range of fields, including physics, astronomy,
+geoscience, bioinformatics, engineering, finance, and deep learning.
+In Python, NumPy_ provides the fundamental data structure and API for
+working with raw ND arrays.
+However, real-world datasets are usually more than just raw numbers;
+they have labels which encode information about how the array values map
+to locations in space, time, etc.
+
+By introducing *dimensions*, *coordinates*, and *attributes* on top of raw
+NumPy-like arrays, xarray is able to understand these labels and use them to
+provide a more intuitive, more concise, and less error-prone experience.
+Xarray also provides a large and growing library of functions for advanced
+analytics and visualization with these data structures.
+Xarray was inspired by and borrows heavily from pandas_, the popular data
+analysis package focused on labelled tabular data.
+Xarray can read and write data from most common labeled ND-array storage
+formats and is particularly tailored to working with netCDF_ files, which were
+the source of xarray's data model.
+
+.. _NumPy: http://www.numpy.org/
 .. _pandas: http://pandas.pydata.org
-.. _Common Data Model: http://www.unidata.ucar.edu/software/thredds/current/netcdf-java/CDM
 .. _netCDF: http://www.unidata.ucar.edu/software/netcdf
-.. _OPeNDAP: http://www.opendap.org/
 
 Documentation
 -------------
@@ -106,7 +120,7 @@ See also
 .. _2015 Unidata Users Workshop talk: https://www.youtube.com/watch?v=J9ypQOnt5l8
 .. _tutorial: https://github.com/Unidata/unidata-users-workshop/blob/master/notebooks/xray-tutorial.ipynb
 .. _with answers: https://github.com/Unidata/unidata-users-workshop/blob/master/notebooks/xray-tutorial-with-answers.ipynb
-.. _Nicolas Fauchereau's tutorial: http://nbviewer.ipython.org/github/nicolasfauchereau/metocean/blob/master/notebooks/xray.ipynb
+.. _Nicolas Fauchereau's tutorial: http://nbviewer.iPython.org/github/nicolasfauchereau/metocean/blob/master/notebooks/xray.ipynb
 
 Get in touch
 ------------

diff --git a/setup.py b/setup.py
@@ -35,19 +35,33 @@
 DESCRIPTION = "N-D labeled arrays and datasets in Python"
 LONG_DESCRIPTION = """
 **xarray** (formerly **xray**) is an open source project and Python package
-that aims to bring the labeled data power of pandas_ to the physical sciences,
-by providing N-dimensional variants of the core pandas data structures.
+that makes working with labelled multi-dimensional arrays simple,
+efficient, and fun!
 
-Our goal is to provide a pandas-like and pandas-compatible toolkit for
-analytics on multi-dimensional arrays, rather than the tabular data for which
-pandas excels. Our approach adopts the `Common Data Model`_ for self-
-describing scientific data in widespread use in the Earth sciences:
-``xarray.Dataset`` is an in-memory representation of a netCDF file.
+Multi-dimensional (a.k.a. N-dimensional, ND) arrays (sometimes called
+"tensors") are an essential part of computational science.
+They are encountered in a wide range of fields, including physics, astronomy,
+geoscience, bioinformatics, engineering, finance, and deep learning.
+In Python, NumPy_ provides the fundamental data structure and API for
+working with raw ND arrays.
+However, real-world datasets are usually more than just raw numbers;
+they have labels which encode information about how the array values map
+to locations in space, time, etc.
 
+By introducing *dimensions*, *coordinates*, and *attributes* on top of raw
+NumPy-like arrays, xarray is able to understand these labels and use them to
+provide a more intuitive, more concise, and less error-prone experience.
+Xarray also provides a large and growing library of functions for advanced
+analytics and visualization with these data structures.
+Xarray was inspired by and borrows heavily from pandas_, the popular data
+analysis package focused on labelled tabular data.
+Xarray can read and write data from most common labeled ND-array storage
+formats and is particularly tailored to working with netCDF_ files, which were
+the source of xarray's data model.
+
+.. _NumPy: http://www.numpy.org/
 .. _pandas: http://pandas.pydata.org
-.. _Common Data Model: http://www.unidata.ucar.edu/software/thredds/current/netcdf-java/CDM
 .. _netCDF: http://www.unidata.ucar.edu/software/netcdf
-.. _OPeNDAP: http://www.opendap.org/
 
 Important links
 ---------------