Skip to content

Commit 8d9f2e9

Browse files
Expanded contributing and added installation section
1 parent e979887 commit 8d9f2e9

File tree

2 files changed

+62
-0
lines changed

2 files changed

+62
-0
lines changed

docs/source/maintenance/index.rst

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,3 +13,31 @@ clone it:
1313
git clone https://github.com/<fork-org>/mkl_random.git
1414
1515
16+
A working compiler is needed build :mod:`mkl_random`.
17+
Both Gnu :code:`g++` and Intel LLVM :code:`icpx` are supported.
18+
19+
Make sure to install Python packages required to build :mod:`mkl_random`:
20+
21+
* python
22+
* numpy
23+
* cython
24+
* setuptools
25+
26+
You would also need Intel(R) MKL library and its headers. Set :code:`MKLROOT` environment
27+
variable so that :code:`${MKLROOT}/include/mkl.h` and :code:`${MKLROOT}/lib/libmkl_rt.so`
28+
can be found.
29+
30+
.. code-block: bash
31+
:caption: Building mkl_random
32+
33+
$ export MKLROOT=</path/to/mkl>
34+
python setup.py develop
35+
36+
To build documentation, install dependencies and running
37+
38+
.. code-block: bash
39+
:caption: Building mkl_random documentation
40+
41+
$ sphinx-build -M html docs/source docs/build
42+
43+
Rendered documentation can be found in "docs/build/html".

docs/source/tutorials.rst

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,37 @@
1+
Installation
2+
============
3+
4+
Package :mod:`mkl_random` is available in conda ecosystem on "conda-forge", default, and "intel" channels.
5+
6+
.. code-block:: bash
7+
:caption: Install mkl_random from conda-forge channel
8+
9+
$ conda install -c conda-forge mkl_random
10+
11+
.. code-block:: bash
12+
:caption: Install mkl_random from intel channel
13+
14+
$ conda install -c intel mkl_random
15+
16+
.. code-block:: bash
17+
:caption: Install mkl_random from default
18+
19+
$ conda install mkl_random
20+
21+
The package can also be installed via :code:`pip`, either from PyPI, or from
22+
23+
.. code-block:: bash
24+
:caption: Install mkl_random using pip from intel channel on Anaconda
25+
26+
$ pip install -i https://pypi.anaconda.org/intel/simple mkl_random
27+
28+
.. code-block:: bash
29+
:caption: Install mkl_random using pip from PyPI
30+
31+
$ pip install mkl_random
32+
33+
The :mod:`mkl_random` is also distributed as part of `Intel(R) Distribution for Python* <https://www.intel.com/content/www/us/en/developer/tools/oneapi/distribution-for-python.html>`_.
34+
135
Beginner's guide
236
================
337

0 commit comments

Comments
 (0)