diff --git a/doc/faq.rst b/doc/faq.rst index 68670d0f5a4..46f1e20f4e8 100644 --- a/doc/faq.rst +++ b/doc/faq.rst @@ -157,6 +157,69 @@ and CDAT have some great domain specific functionality, and we would love to have support for converting their native objects to and from xarray (see :issue:`37` and :issue:`133`) + +What other projects leverage xarray? +------------------------------------ + +Here are several existing libraries that build functionality upon xarray. + +Geosciences +~~~~~~~~~~~ + +- `aospy `_: Automated analysis and management of gridded climate data. +- `infinite-diff `_: xarray-based finite-differencing, focused on gridded climate/meterology data +- `marc_analysis `_: Analysis package for CESM/MARC experiments and output. +- `MPAS-Analysis `_: Analysis for simulations produced with Model for Prediction Across Scales (MPAS) components and the Accelerated Climate Model for Energy (ACME). +- `OGGM `_: Open Global Glacier Model +- `Oocgcm `_: Analysis of large gridded geophysical datasets +- `Open Data Cube `_: Analysis toolkit of continental scale Earth Observation data from satellites. +- `Pangaea: `_: xarray extension for gridded land surface & weather model output). +- `Pangeo `_: A community effort for big data geoscience in the cloud. +- `PyGDX `_: Python 3 package for + accessing data stored in GAMS Data eXchange (GDX) files. Also uses a custom + subclass. +- `Regionmask `_: plotting and creation of masks of spatial regions +- `salem `_: Adds geolocalised subsetting, masking, and plotting operations to xarray's data structures via accessors. +- `Spyfit `_: FTIR spectroscopy of the atmosphere +- `windspharm `_: Spherical + harmonic wind analysis in Python. +- `wrf-python `_: A collection of diagnostic and interpolation routines for use with output of the Weather Research and Forecasting (WRF-ARW) Model. +- `xarray-simlab `_: xarray extension for computer model simulations. +- `xarray-topo `_: xarray extension for topographic analysis and modelling. +- `xbpch `_: xarray interface for bpch files. +- `xESMF `_: Universal Regridder for Geospatial Data. +- `xgcm `_: 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. +- `xmitgcm `_: a python package for reading `MITgcm `_ binary MDS files into xarray data structures. +- `xshape `_: Tools for working with shapefiles, topographies, and polygons in xarray. + +Machine Learning +~~~~~~~~~~~~~~~~ +- `cesium `_: machine learning for time series analysis +- `Elm `_: Parallel machine learning on xarray data structures +- `sklearn-xarray (1) `_: Combines scikit-learn and xarray (1). +- `sklearn-xarray (2) `_: Combines scikit-learn and xarray (2). + +Extend xarray capabilities +~~~~~~~~~~~~~~~~~~~~~~~~~~ +- `Collocate `_: Collocate xarray trajectories in arbitrary physical dimensions +- `eofs `_: EOF analysis in Python. +- `xarray_extras `_: Advanced algorithms for xarray objects (e.g. intergrations/interpolations). +- `xrft `_: Fourier transforms for xarray data. +- `xr-scipy `_: A lightweight scipy wrapper for xarray. +- `X-regression `_: Multiple linear regression from Statsmodels library coupled with Xarray library. + +Visualization +~~~~~~~~~~~~~ +- `Datashader `_, `geoviews `_, `holoviews `_, : visualization packages for large data +- `psyplot `_: Interactive data visualization with python. + +Other +~~~~~ +- `ptsa `_: EEG Time Series Analysis +- `pycalphad `_: Computational Thermodynamics in Python + +More projects can be found at the `"xarray" Github topic `_. + How should I cite xarray? ------------------------- diff --git a/doc/internals.rst b/doc/internals.rst index e5e14896472..170e2d0b0cc 100644 --- a/doc/internals.rst +++ b/doc/internals.rst @@ -130,20 +130,3 @@ To help users keep things straight, please `let us know `_ if you plan to write a new accessor for an open source library. In the future, we will maintain a list of accessors and the libraries that implement them on this page. - -Here are several existing libraries that build functionality upon xarray. -They may be useful points of reference for your work: - -- `xgcm `_: General Circulation Model - Postprocessing. Uses subclassing and custom xarray backends. -- `PyGDX `_: Python 3 package for - accessing data stored in GAMS Data eXchange (GDX) files. Also uses a custom - subclass. -- `windspharm `_: Spherical - harmonic wind analysis in Python. -- `eofs `_: EOF analysis in Python. -- `salem `_: Adds geolocalised subsetting, - masking, and plotting operations to xarray's data structures via accessors. - -.. TODO: consider adding references to these projects somewhere more prominent -.. in the documentation? maybe the FAQ page? diff --git a/doc/whats-new.rst b/doc/whats-new.rst index cc5506b553c..aa663e0033c 100644 --- a/doc/whats-new.rst +++ b/doc/whats-new.rst @@ -31,6 +31,12 @@ What's New v0.10.4 (unreleased) -------------------- +Documentation +~~~~~~~~~~~~~ +- `FAQ `_ now lists projects that leverage xarray. + By `Deepak Cherian `_. + + Enhancements ~~~~~~~~~~~~ @@ -45,6 +51,8 @@ Enhancements This greatly boosts speed and allows chunking on the core dims. The function now requires dask >= 0.17.3 to work on dask-backed data (:issue:`2074`). By `Guido Imperiale `_. +- ``plot.line()`` learned new kwargs: ``xincrease``, ``yincrease`` that change the direction of the respective axes. + By `Deepak Cherian `_. Bug fixes ~~~~~~~~~ @@ -63,8 +71,6 @@ Bug fixes By `Stephan Hoyer `_. - ``plot.line()`` does not call ``autofmt_xdate()`` anymore. Instead it changes the rotation and horizontal alignment of labels without removing the x-axes of any other subplots in the figure (if any). By `Deepak Cherian `_. -- ``plot.line()`` learned new kwargs: ``xincrease``, ``yincrease`` that change the direction of the respective axes. - By `Deepak Cherian `_. - Colorbar limits are now determined by excluding ±Infs too. By `Deepak Cherian `_.