Skip to content

index.rst

Latest commit

 

History

History
50 lines (32 loc) · 1.28 KB

index.rst

File metadata and controls

50 lines (32 loc) · 1.28 KB

Contributing

:mod:`mkl_random` is an free and open source project. We welcome and appreciate your contributions.

To contribute, fork the repo https://github.com/IntelPython/mkl_random.git, clone it:

     git clone https://github.com/<fork-org>/mkl_random.git

A working compiler is needed build :mod:`mkl_random`. Both Gnu g++ and Intel LLVM icpx are supported.

Make sure to install Python packages required to build :mod:`mkl_random`:

You would also need Intel(R) MKL library and its headers. Set MKLROOT environment variable so that ${MKLROOT}/include/mkl.h and ${MKLROOT}/lib/libmkl_rt.so can be found.

   $ export MKLROOT=</path/to/mkl>
   python -m pip install .

To run test suite, install :mod:`pytest`, and run

   python -m pytest mkl_random/tests

To build documentation, install dependencies and running

   $ sphinx-build -M html docs/source docs/build

Rendered documentation can be found in "docs/build/html".