Skip to content

Commit 4de10cf

Browse files
author
Takaya Uchida
committed
rich structure text for readme
1 parent a8d934e commit 4de10cf

File tree

5 files changed

+38
-15
lines changed

5 files changed

+38
-15
lines changed

README.md

Lines changed: 0 additions & 12 deletions
This file was deleted.

README.rst

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
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

appveyor.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ environment:
88
MINICONDA: C:\Miniconda
99

1010
- PYTHON: "C:\\Python36"
11-
PYTHON_VERSION: "3.6.1"
11+
PYTHON_VERSION: "3.6.7"
1212
PYTHON_ARCH: "32"
1313
MINICONDA: C:\Miniconda3
1414

setup.cfg

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
[metadata]
2-
description-file = README.md
2+
description-file = README.rst
33

44
[aliases]
55
test=pytest

setup.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@
2828

2929
DESCRIPTION = "Discrete Fourier Transform with xarray"
3030
def readme():
31-
with open('README.md') as f:
31+
with open('README.rst') as f:
3232
return f.read()
3333

3434
setup(name=DISTNAME,

0 commit comments

Comments
 (0)