Skip to content

update install docs #122

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: dev
Choose a base branch
from
Open

update install docs #122

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion docs/install.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,12 @@ We recommend installing `transcriptomic_clustering` into a managed Python enviro

Two popular tools for managing Python environments are `anaconda <https://anaconda.org/anaconda/anaconda-project>`_ and `venv <https://docs.python.org/3/library/venv.html>`_. The rest of this document assumes that you have created and activated an environment using one of these tools. Using anaconda, this looks like:

You only need to include gcc_linux-64 and gxx_linux if you see a compiler error related to annoy.
Likewise nb_conda and matplotlib are optional, used for in the notebooks.

.. code-block:: bash

conda create -y --name environment-name python=3.8
conda create -y --name environment-name python=3.8 gcc_linux-64 gxx_linux-64 nb_conda matplotlib
conda activate environment-name

and using venv:
Expand Down