Add "awesome xarray" list to faq. #2118

dcherian · 2018-05-11T07:45:59Z

partially addresses #1850
closes #946

I tried to make an "awesome xarray" list by doing a github search for 'xarray'. I only put packages that looked like they were intended for general use. Also, I moved the list from internals.rst to faq.rst.

Let me know if there are any I've missed or any that should be added.

fmaussion

Thanks! I like how they are organized alphabetically now :D

fmaussion · 2018-05-11T12:49:18Z

doc/faq.rst

+- `PyGDX <https://pygdx.readthedocs.io/en/latest/>`_: Python 3 package for
+  accessing data stored in GAMS Data eXchange (GDX) files. Also uses a custom
+  subclass.
+- `salem <https://salem.readthedocs.io>`_: Adds geolocalised subsetting,


was: "Adds geolocalised subsetting, masking, and plotting operations to xarray's data structures via accessors."

(the second line is gone in your PR)

fmaussion · 2018-05-11T12:49:47Z

doc/faq.rst

+- `xbpch <https://github.com/darothen/xbpch>`_: xarray interface for bpch files.
+- `xESMF <https://xesmf.readthedocs.io>`_: Universal Regridder for Geospatial Data.
+- `xgcm <https://xgcm.readthedocs.io/>`_: General Circulation Model Postprocessing. Uses subclassing and custom xarray backends.
+- `xshape <https://xshape.readthedocs.io/>`_: Tools for working with shapefiles, topographies, and polygons in xarray


nit: the others have a dot at the end of their description

rabernat · 2018-05-11T13:50:33Z

doc/faq.rst

+- `xarray-topo <https://gitext.gfz-potsdam.de/sec55-public/xarray-topo>`_: xarray extension for topographic analysis and modelling.
+- `xbpch <https://github.com/darothen/xbpch>`_: xarray interface for bpch files.
+- `xESMF <https://xesmf.readthedocs.io>`_: Universal Regridder for Geospatial Data.
+- `xgcm <https://xgcm.readthedocs.io/>`_: General Circulation Model Postprocessing. Uses subclassing and custom xarray backends.


Actually we do not subclass xarray or provide any custom backends. Here is the brief description of xgcm

xgcm is a python packge for working with the datasets produced by numerical General Circulation Models (GCMs) and similar gridded datasets that are amenable to finite volume analysis. In these datasets, different variables are located at different positions with respect to a volume or area element (e.g. cell center, cell face, etc.) xgcm solves the problem of how to interpolate and difference these variables from one position to another.

This could be shortened to the following: "extends the xarray data model to understand finite volume grid cells (common in General Circulation Models) and provides interpolation and difference operations for such grids."

I would also include these two:

- `xmitgcm <http://xgcm.readthedocs.io/>`_: a python package for reading MITgcm binary MDS files into xarray data structures. - `xrft <https://github.com/rabernat/xrft>`_: Fourier transforms for xarray data.

Thanks. The subclassing stuff was in the previous version of this list.

shoyer · 2018-05-12T06:11:35Z

Awesome, thank you!

Maybe it's worth linking the "xarray" GitHub topic as well: https://github.com/topics/xarray ?

shoyer · 2018-05-12T07:20:05Z

doc/faq.rst

+- `aospy <https://aospy.readthedocs.io>`_: Automated analysis and management of gridded climate data.
+- `eofs <https://ajdawson.github.io/eofs/>`_: EOF analysis in Python.
+- `MPAS-Analysis <http://mpas-analysis.readthedocs.io>`_: Analysis for simulations produced with Model for Prediction Across Scales (MPAS) components and the Accelerated Climate Model for Energy (ACME).
+- `psyplot <https://https://psyplot.readthedocs.io>`_: Interactive data visualization with python.


typo in the URL

jhamman · 2018-05-12T14:29:45Z

doc/faq.rst

+- `aospy <https://aospy.readthedocs.io>`_: Automated analysis and management of gridded climate data.
+- `eofs <https://ajdawson.github.io/eofs/>`_: EOF analysis in Python.
+- `MPAS-Analysis <http://mpas-analysis.readthedocs.io>`_: Analysis for simulations produced with Model for Prediction Across Scales (MPAS) components and the Accelerated Climate Model for Energy (ACME).
+- `psyplot <https://https://psyplot.readthedocs.io>`_: Interactive data visualization with python.


Can we also add pangeo to this list: https://pangeo-data.github.io

jhamman · 2018-05-12T14:30:09Z

doc/faq.rst

+- `xmitgcm <http://xgcm.readthedocs.io/>`_: a python package for reading `MITgcm <http://mitgcm.org/>`_ binary MDS files into xarray data structures.
+- `xrft <https://github.com/rabernat/xrft>`_: Fourier transforms for xarray data.
+- `xshape <https://xshape.readthedocs.io/>`_: Tools for working with shapefiles, topographies, and polygons in xarray.
+


Here's a list I had put together for our numfocus application:

Pangeo: A community effort for big-data geoscience Pandas: high-performance, easy-to-use data structures and data analysis tools xgcm: for analyzing general circulation model output data MPAS Analysis: Provides analysis for the MPAS components of ACME marc_analysis: Analysis package for CESM/MARC experiments and output Oocgcm: Analysis of large gridded geophysical datasets windspharm: wind spherical harmonics eofs: empirical orthogonal functions infinite-diff: xarray-based finite-differencing aospy: Climate data analysis, database, and visualization Spyfit: FTIR spectroscopy of the atmosphere Pangaea: xarray extension for gridded land surface & weather model output Datashader: visualization for large data cesium: machine learning for time series analysis ptsa: EEG Time Series Analysis pyGDX: GDX file data access pycalphad: Computational Thermodynamics in Python Regionmask: plotting and creation of masks of spatial regions Salem: geolocalised subsetting, masking, and plotting OGGM: Open Global Glacier Model xESMF: Universal Regridder for Geospatial Data sklearn-xarray: scikit-learn machine learning framework for xarray objects xarray-simlab: computational model development xrft: Fourier transforms on xarray data structures Elm: Parallel machine learning on xarray data structures Collocate: Collocate xarray trajectories in arbitrary physical dimensions X-regression: Multiple linear regression from Statsmodels library coupled with Xarray library Open Data Cube: Analysis toolkit of continental scale Earth Observation data

fujiisoup · 2018-05-13T07:55:56Z

I would be happy if
xr-scipy: https://github.com/fujiisoup/xr-scipy
and
xarray-extras: https://github.com/crusaderky/xarray_extras
are added to this list.

dcherian · 2018-05-14T14:40:28Z

So Cesium doesn't list xarray as a dependency: http://cesium-ml.org/docs/install.html
Am I looking at the right package?

I've added some organization and put "regionmask, salem, xarray-top" etc under the subheading "Topography". Can someone suggest a better title please?

fmaussion · 2018-05-14T14:49:50Z

I've added some organization and put "regionmask, salem, xarray-top" etc under the subheading "Topography". Can someone suggest a better title please?

I would not add any subheader at all and keep them all under "Geosciences".

shoyer · 2018-05-14T19:03:16Z

I think this is ready to merge?

dcherian · 2018-05-14T19:24:39Z

Yes, I'm all done.

jhamman

Looks great. Thanks!

shoyer · 2018-05-14T21:04:36Z

thanks!

dcherian force-pushed the doc/awesome-xarray branch from f527d63 to 087779b Compare May 11, 2018 07:53

fmaussion reviewed May 11, 2018

View reviewed changes

rabernat reviewed May 11, 2018

View reviewed changes

dcherian force-pushed the doc/awesome-xarray branch 2 times, most recently from aa3e00d to d0a12bb Compare May 12, 2018 07:00

shoyer approved these changes May 12, 2018

View reviewed changes

jhamman reviewed May 12, 2018

View reviewed changes

dcherian and others added 8 commits May 14, 2018 08:18

Add "awesome xarray" list to faq.

58640b1

Add whats new entry + bugfix earlier entry.

73293ac

Fixes + add xrft, xmitgcm.

8655219

Add link to xarray github topic.

705405f

Add more links plus add some organization.

4edebd0

Remove "points of reference" sentence

629eaf2

Remove subheadings under geosciences.

e5a2613

whats-new bugfix.

a8e0be8

dcherian force-pushed the doc/awesome-xarray branch from 2eb4ca6 to a8e0be8 Compare May 14, 2018 15:19

jhamman approved these changes May 14, 2018

View reviewed changes

shoyer merged commit 29d608a into pydata:master May 14, 2018

dcherian deleted the doc/awesome-xarray branch May 14, 2018 21:19

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add "awesome xarray" list to faq. #2118

Add "awesome xarray" list to faq. #2118

dcherian commented May 11, 2018 •

edited

Loading

fmaussion left a comment

fmaussion May 11, 2018

fmaussion May 11, 2018

rabernat May 11, 2018 •

edited

Loading

dcherian May 11, 2018

shoyer commented May 12, 2018

shoyer May 12, 2018

jhamman May 12, 2018

jhamman May 12, 2018

fujiisoup commented May 13, 2018

dcherian commented May 14, 2018

fmaussion commented May 14, 2018

shoyer commented May 14, 2018

dcherian commented May 14, 2018

jhamman left a comment

shoyer commented May 14, 2018

Add "awesome xarray" list to faq. #2118

Add "awesome xarray" list to faq. #2118

Conversation

dcherian commented May 11, 2018 • edited Loading

fmaussion left a comment

Choose a reason for hiding this comment

fmaussion May 11, 2018

Choose a reason for hiding this comment

fmaussion May 11, 2018

Choose a reason for hiding this comment

rabernat May 11, 2018 • edited Loading

Choose a reason for hiding this comment

dcherian May 11, 2018

Choose a reason for hiding this comment

shoyer commented May 12, 2018

shoyer May 12, 2018

Choose a reason for hiding this comment

jhamman May 12, 2018

Choose a reason for hiding this comment

jhamman May 12, 2018

Choose a reason for hiding this comment

fujiisoup commented May 13, 2018

dcherian commented May 14, 2018

fmaussion commented May 14, 2018

shoyer commented May 14, 2018

dcherian commented May 14, 2018

jhamman left a comment

Choose a reason for hiding this comment

shoyer commented May 14, 2018

dcherian commented May 11, 2018 •

edited

Loading

rabernat May 11, 2018 •

edited

Loading