Skip to content

Commit 65d80f6

Browse files
MAINT: Filled in description fields, etc.
1. Populated description and long_description fields to `setup`. 2. Added `install_requires = ['numpy', 'cython']` to `setup` call. 3. Updated `build/always_include_files` in `conda-recipe/meta.yaml` to include cached files, both for Python 3 and Python 2, to ensure that `conda remove mkl_fft` removes all the artifacts from the conda environment. 4. Updated `README.md` to states steps required to install `mkl_fft` using `pip`.
1 parent 07a072c commit 65d80f6

File tree

3 files changed

+21
-6
lines changed

3 files changed

+21
-6
lines changed

README.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,4 +51,11 @@ It implements the following functions:
5151
... and similar `irfft*` functions.
5252

5353

54-
The package also provides `mkl_fft._numpy_fft` and `mkl_fft._scipy_fft` interfaces which provide drop-in replacements for equivalent functions in NumPy and SciPy respectively.
54+
The package also provides `mkl_fft._numpy_fft` and `mkl_fft._scipy_fft` interfaces which provide drop-in replacements for equivalent functions in NumPy and SciPy respectively.
55+
56+
---
57+
58+
To build ``mkl_fft`` from sources on Linux:
59+
- install a recent version of MKL, if necessary;
60+
- execute ``source /path/to/mklroot/bin/mklvars.sh intel64`` ;
61+
- execute ``pip install .``

conda-recipe/meta.yaml

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{% set version = "1.0.0" %}
2-
{% set buildnumber = 14 %}
2+
{% set buildnumber = 0 %}
33

44
### If you change the iccver here, you must also set the path correctly in build.sh / bld.bat!!!
55
{% set iccver = "16.0.3" %} [unix or py3k]
@@ -25,8 +25,15 @@ build:
2525
- {{ SP_DIR.replace('\\', '/') if win else SP_DIR }}/mkl_fft/_scipy_fft.py
2626
- {{ SP_DIR.replace('\\', '/') if win else SP_DIR }}/mkl_fft/setup.py
2727
- {{ SP_DIR.replace('\\', '/') if win else SP_DIR }}/mkl_fft/tests/test_fft1d.py
28-
- {{ SP_DIR.replace('\\', '/') if win else SP_DIR }}/mkl_fft/__pycache__/*
29-
- {{ SP_DIR.replace('\\', '/') if win else SP_DIR }}/mkl_fft/tests/__pycache__/*
28+
- {{ SP_DIR.replace('\\', '/') if win else SP_DIR }}/mkl_fft/__init__.pyc [py27]
29+
- {{ SP_DIR.replace('\\', '/') if win else SP_DIR }}/mkl_fft/_float16_utils.pyc [py27]
30+
- {{ SP_DIR.replace('\\', '/') if win else SP_DIR }}/mkl_fft/_numpy_fft.pyc [py27]
31+
- {{ SP_DIR.replace('\\', '/') if win else SP_DIR }}/mkl_fft/_scipy_fft.pyc [py27]
32+
- {{ SP_DIR.replace('\\', '/') if win else SP_DIR }}/mkl_fft/setup.pyc [py27]
33+
- {{ SP_DIR.replace('\\', '/') if win else SP_DIR }}/mkl_fft/tests/test_fft1d.pyc [py27]
34+
- {{ SP_DIR.replace('\\', '/') if win else SP_DIR }}/mkl_fft/__pycache__/* [py3k]
35+
- {{ SP_DIR.replace('\\', '/') if win else SP_DIR }}/mkl_fft/tests/__pycache__/* [py3k]
36+
- {{ SP_DIR.replace('\\', '/') if win else SP_DIR }}/mkl_fft/
3037

3138
requirements:
3239
build:

setup.py

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -77,8 +77,8 @@ def setup_package():
7777
name = 'mkl_fft',
7878
maintainer = "Intel Corp.",
7979
maintainer_email = "[email protected]",
80-
description = "",
81-
long_description = """""",
80+
description = "MKL-based FFT transforms for NumPy arrays",
81+
long_description = """NumPy-based implementation of Fast Fourier Transform using Intel (R) Math Kernel Library. 1D and ND, complex and real transforms, in-place and not-in-place on single and double precision arrays""",
8282
url = "http://github.com/IntelPython/mkl_fft",
8383
author = "Oleksandr Pavlyk",
8484
download_url = "http://github.com/IntelPython/mkl_fft",
@@ -87,6 +87,7 @@ def setup_package():
8787
platforms = ["Windows", "Linux", "Mac OS-X"],
8888
test_suite = 'nose.collector',
8989
python_requires = '>=2.7,!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*',
90+
install_requires = ['numpy', 'cython'],
9091
configuration = configuration
9192
)
9293
setup(**metadata)

0 commit comments

Comments
 (0)