Skip to content

Commit

Permalink
Update Python installation instruction
Browse files Browse the repository at this point in the history
Suggest updating pip & also point people to the nightly wheels
  • Loading branch information
Luthaf committed Oct 6, 2023
1 parent 365e79f commit f3f50c9
Showing 1 changed file with 28 additions and 1 deletion.
29 changes: 28 additions & 1 deletion docs/src/get-started/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,33 @@ install using `rustup <https://rustup.rs/>`_ or your OS package manager.
Installing the Python module
----------------------------

For building and using the Python package, clone the repository using `git
<https://git-scm.com>`_ and install rascaline using `pip
<https://pip.pypa.io>`_.

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:

Expand Down Expand Up @@ -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
Expand Down

0 comments on commit f3f50c9

Please sign in to comment.