Skip to content

Commit da0077f

Browse files
committed
Add conda environment to installation instructions
1 parent 00c4c3b commit da0077f

File tree

2 files changed

+33
-0
lines changed

2 files changed

+33
-0
lines changed

docs/_static/environment.yaml

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
name: scimilarity
2+
channels:
3+
- nvidia
4+
- pytorch
5+
- bioconda
6+
- conda-forge
7+
dependencies:
8+
- python=3.10
9+
- ipykernel
10+
- ipython
11+
- ipywidgets
12+
- leidenalg
13+
- pip

docs/install.rst

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,13 @@ and installed as follows:
2929
high memory requirements. To make queries, you will need at least 64 GB of
3030
system RAM.
3131

32+
.. warning::
33+
34+
If your environment has sufficient memory but loading the model or making
35+
kNN queries crashes, that may be due to older versions of dependencies such
36+
as hnswlib or numpy. We recommend using either using the Docker container
37+
or Conda environment described below.
38+
3239
.. note::
3340

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

51+
Conda environment setup
52+
--------------------------------------------------------------------------------
53+
54+
To install the SCimilarity API in a [Conda](https://docs.conda.io) environment
55+
we recommend this environment setup:
56+
57+
:download:`Download environment file <_static/environment.yaml>`
58+
59+
.. literalinclude:: _static/environment.yaml
60+
:language: YAML
61+
62+
Followed by installing the ``scimilarity`` package via ``pip``, as above.
63+
4464
Using the SCimilarity Docker container
4565
--------------------------------------------------------------------------------
4666

0 commit comments

Comments
 (0)