Skip to content

Commit

Permalink
actually more complicated for cupy
Browse files Browse the repository at this point in the history
  • Loading branch information
timothyas committed Oct 27, 2023
1 parent 024f626 commit 9109fdc
Showing 1 changed file with 8 additions and 5 deletions.
13 changes: 8 additions & 5 deletions docs/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,15 +12,11 @@ and install it as follows::
cd xesn
pip install -e .

Note that additional dependencies can be installed to run the unit test suite,::
Note that additional dependencies can be installed to run the unit test suite::

pip install -e .[test]
pytest xesn/test/*.py

or to install `cupy <https://cupy.dev/>`_ to run on GPUs::

pip install -e .[gpus]

Alternatively, the package can be installed via pip::

pip install git+https://github.com/timothyas/xesn.git
Expand All @@ -43,3 +39,10 @@ there are a couple of additional dependencies required::

conda env create -f docs/environment.yaml
conda activate xesn

Using GPUs
==========

In order to use this package on GPUs, please install cupy separately, following
their installation instructions
`here <https://docs.cupy.dev/en/stable/install.html>`_.

0 comments on commit 9109fdc

Please sign in to comment.