From f3f50c97d9b5f5c72f730b96ddd4f30503e740ad Mon Sep 17 00:00:00 2001 From: Guillaume Fraux Date: Fri, 6 Oct 2023 16:21:14 +0200 Subject: [PATCH] Update Python installation instruction Suggest updating pip & also point people to the nightly wheels --- docs/src/get-started/installation.rst | 29 ++++++++++++++++++++++++++- 1 file changed, 28 insertions(+), 1 deletion(-) diff --git a/docs/src/get-started/installation.rst b/docs/src/get-started/installation.rst index 034165dc1..3c01322b9 100644 --- a/docs/src/get-started/installation.rst +++ b/docs/src/get-started/installation.rst @@ -10,9 +10,33 @@ install using `rustup `_ or your OS package manager. Installing the Python module ---------------------------- +For building and using the Python package, clone the repository using `git +`_ and install rascaline using `pip +`_. + +From source: + +.. code-block:: bash + + # Make sure you are using the latest version of pip + pip install --upgrade pip + + git clone https://github.com/Luthaf/rascaline + cd rascaline + pip install . + + # alternatively, the same thing in a single command + pip install git+https://github.com/Luthaf/rascaline + + +Rascaline is also provided as prebuilt wheel which avoids the intermediate step +of building the package with a Rust compiler from the source code. + .. code-block:: bash - pip install git+https://github.com/Luthaf/rascaline.git + pip install --upgrade pip + pip install --extra-index-url https://luthaf.fr/temporary-wheels/ rascaline + .. _install-c-lib: @@ -96,6 +120,9 @@ Building from source: cd rascaline/python/rascaline-torch pip install . + # Make sure you are using the latest version of pip + pip install --upgrade pip + # alternatively, the same thing in a single command pip install git+https://github.com/luthaf/rascaline#subdirectory=python/rascaline-torch