diff --git a/README.md b/README.md index 3322c7c..5a4fbc8 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,31 @@ powered version of loops used in the patched version of [NumPy](https://numpy.or Patches were factored out per community feedback ([NEP-36](https://numpy.org/neps/nep-0036-fair-play.html)). +`mkl_umath` started as a part of Intel (R) Distribution for Python* optimizations to NumPy, and is now being released +as a stand-alone package. It can be installed into conda environment using + +``` + conda install -c intel mkl_umath +``` + +--- + +To install mkl_umath Pypi package please use following command: + +``` + python -m pip install --i https://pypi.anaconda.org/intel/simple -extra-index-url https://pypi.org/simple mkl_umath +``` + +If command above installs NumPy package from the Pypi, please use following command to install Intel optimized NumPy wheel package from Anaconda Cloud: + +``` + python -m pip install --i https://pypi.anaconda.org/intel/simple -extra-index-url https://pypi.org/simple mkl_umath numpy== +``` + +Where `` should be the latest version from https://anaconda.org/intel/numpy + +--- + ## Building Intel(R) C compiler and Intel(R) Math Kernel Library are required to build `mkl_umath` from source: diff --git a/setup.py b/setup.py index fb9b500..1ab571e 100644 --- a/setup.py +++ b/setup.py @@ -30,10 +30,13 @@ with io.open('mkl_umath/_version.py', 'rt', encoding='utf8') as f: version = re.search(r'__version__ = \'(.*?)\'', f.read()).group(1) +with open("README.md", "r", encoding="utf-8") as file: + long_description = file.read() + VERSION = version CLASSIFIERS = """\ -Development Status :: 0 - Alpha +Development Status :: 5 - Production/Stable Intended Audience :: Science/Research Intended Audience :: Developers License :: OSI Approved @@ -75,7 +78,8 @@ def setup_package(): maintainer = "Intel Corp.", maintainer_email = "scripting@intel.com", description = "MKL-based universal functions for NumPy arrays", - long_description = """Universal functions for real and complex floating point arrays powered by Intel(R) Math Kernel Library Vector (Intel(R) MKL) and Intel(R) Short Vector Math Library (Intel(R) SVML)""", + long_description = long_description, + long_description_content_type="text/markdown", url = "http://github.com/IntelPython/mkl_umath", author = "Intel Corporation", download_url = "http://github.com/IntelPython/mkl_umath",