Skip to content

Commit

Permalink
Add conda environment to installation instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
javh committed Dec 20, 2024
1 parent 00c4c3b commit da0077f
Show file tree
Hide file tree
Showing 2 changed files with 33 additions and 0 deletions.
13 changes: 13 additions & 0 deletions docs/_static/environment.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
name: scimilarity
channels:
- nvidia
- pytorch
- bioconda
- conda-forge
dependencies:
- python=3.10
- ipykernel
- ipython
- ipywidgets
- leidenalg
- pip
20 changes: 20 additions & 0 deletions docs/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,13 @@ and installed as follows:
high memory requirements. To make queries, you will need at least 64 GB of
system RAM.

.. warning::

If your environment has sufficient memory but loading the model or making
kNN queries crashes, that may be due to older versions of dependencies such
as hnswlib or numpy. We recommend using either using the Docker container
or Conda environment described below.

.. note::

A GPU is not necessary for most applications, but model training will
Expand All @@ -41,6 +48,19 @@ You can download the following pretrained models for use with SCimilarity from
Zenodo:
https://zenodo.org/records/10685499

Conda environment setup
--------------------------------------------------------------------------------

To install the SCimilarity API in a [Conda](https://docs.conda.io) environment
we recommend this environment setup:

:download:`Download environment file <_static/environment.yaml>`

.. literalinclude:: _static/environment.yaml
:language: YAML

Followed by installing the ``scimilarity`` package via ``pip``, as above.

Using the SCimilarity Docker container
--------------------------------------------------------------------------------

Expand Down

0 comments on commit da0077f

Please sign in to comment.