Contributing

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:

How to clone the repo
     git clone https://github.com/<fork-org>/mkl_random.git

A working compiler is needed to build mkl_random. Gnu g++, standard clang++, and Intel LLVM icpx are supported.

Make sure to install Python packages required to build mkl_random:

  • python

  • numpy

  • cython

  • meson-python

  • ninja

  • cmake

  • mkl-devel

The Intel(R) MKL library and its headers are provided by the mkl-devel package and located through CMake, so no environment variable needs to be set.

Building mkl_random
   python -m pip install . --no-build-isolation --no-deps

To run test suite, install pytest, and run

Running mkl_random test suite
   python -m pytest mkl_random/tests

To build documentation, install dependencies and running

Building mkl_random documentation
   $ sphinx-build -M html docs/source docs/build

Rendered documentation can be found in “docs/build/html”.