|
| 1 | +xrft: Fourier transforms for xarray data |
| 2 | +========================================= |
| 3 | + |
| 4 | +.. image:: https://travis-ci.org/xgcm/xrft.svg?branch=master |
| 5 | + :target: https://travis-ci.org/xgcm/xrft |
| 6 | +.. image:: https://codecov.io/gh/xgcm/xrft/branch/master/graph/badge.svg |
| 7 | + :target: https://codecov.io/gh/xgcm/xrft |
| 8 | +.. image:: https://readthedocs.org/projects/xrft/badge/?version=latest |
| 9 | + :target: https://xrft.readthedocs.io/en/latest/?badge=latest |
| 10 | + :alt: Documentation Status |
| 11 | +.. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.1402636.svg |
| 12 | + :target: https://doi.org/10.5281/zenodo.1402636 |
| 13 | + |
| 14 | +**xrft** is an open-source Python package for |
| 15 | +taking the discrete Fourier transform (DFT) on xarray_ and dask_ arrays. |
| 16 | + |
| 17 | +.. _xarray: http://xarray.pydata.org/en/stable/ |
| 18 | +.. _dask: https://dask.org |
| 19 | + |
| 20 | +It is: |
| 21 | + |
| 22 | +- **Powerful**: It keeps the metadata and coordinates of the original xarray dataset and provides a clean work flow of DFT. |
| 23 | +- **Easy-to-use**: It uses the native arguments of `numpy FFT`_ and provides a simple, high-level API. |
| 24 | +- **Fast**: It uses the `dask API of FFT`_ and `map_blocks`_ to allow parallelization of DFT. |
| 25 | + |
| 26 | +.. _numpy FFT: https://docs.scipy.org/doc/numpy/reference/routines.fft.html |
| 27 | +.. _dask API of FFT: http://docs.dask.org/en/latest/array-api.html?highlight=fft#fast-fourier-transforms |
| 28 | +.. _map_blocks: http://docs.dask.org/en/latest/array-api.html?highlight=map_blocks#dask.array.core.map_blocks |
| 29 | + |
| 30 | +Get in touch |
| 31 | +------------ |
| 32 | + |
| 33 | +- Report bugs, suggest features or view the source code `on GitHub`_. |
| 34 | + |
| 35 | +.. _on GitHub: https://github.com/xgcm/xrft |
0 commit comments