diff --git a/docs/overview/python-package.rst b/docs/overview/python-package.rst index c034e6244..57255d5e8 100644 --- a/docs/overview/python-package.rst +++ b/docs/overview/python-package.rst @@ -12,6 +12,12 @@ Below is a diagram that provides insights on the relationship between Vulkan Kom Package Installation ^^^^^^^^^ +Make sure you have the following dependencies installed: + +* CMAKE v3.41+ (install in [Windows](https://tulip.labri.fr/TulipDrupal/?q=node/1081), [Linux (Ubuntu)](https://vitux.com/how-to-install-cmake-on-ubuntu-18-04/), [Mac](https://medium.com/r?url=https%3A%2F%2Fstackoverflow.com%2Fa%2F59825656%2F1889253)) +* Vulkan SDK installed via [official website](https://vulkan.lunarg.com/sdk/home) +* C++ compiler (eg. gcc for linux / mac, MSVC for Windows) + Once you set up the package dependencies, you can install Kompute from ```Pypi``` using ```pip``` by running: .. code-block:: bash @@ -24,6 +30,7 @@ You can also install from master branch using: pip install git+git://github.com/EthicalML/vulkan-kompute.git@master + Core Python Components ^^^^^^^^