Skip to content

Commit

Permalink
Add channels for pip conda env (#2067)
Browse files Browse the repository at this point in the history
* Add channels for pypi conda env

* Trigger dev website build
  • Loading branch information
roomrys authored Dec 18, 2024
1 parent 55772ad commit a6f65fb
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 8 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/website.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ on:
# 'main' triggers updates to 'sleap.ai', all others to 'sleap.ai/develop'
- main
- develop
- liezl/update-intallation-docs-1.4.1 # again!
- liezl/add-channels-for-pip-conda-env
paths:
- "docs/**"
- "README.rst"
Expand Down
13 changes: 6 additions & 7 deletions docs/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ local:
Installation requires entering commands in a terminal. To open one:
````{tabs}
```{tab} Windows
Open the *Start menu* and search for the *Anaconda Prompt* (if using Miniconda) or the *Command Prompt* if not.
Open the *Start menu* and search for the *Anaconda Prompt* (if using Miniconda) or the *Command Prompt* if not.
```{note}
On Windows, our personal preference is to use alternative terminal apps like [Cmder](https://cmder.net) or [Windows Terminal](https://aka.ms/terminal).
```
Expand Down Expand Up @@ -66,7 +66,6 @@ If you don't have a `conda` package manager installation, here are some quick in

Miniforge is a minimal installer for conda that includes the `conda` package manager and is maintained by the [conda-forge](https://conda-forge.org) community. The only difference between Miniforge and Miniconda is that Miniforge uses the `conda-forge` channel by default, which provides a much wider selection of community-maintained packages.


````{tabs}
```{group-tab} Windows
Open a new PowerShell terminal (does not need to be admin) and enter:
Expand Down Expand Up @@ -135,20 +134,20 @@ This is a minimal installer for conda that includes the `conda` package manager

See the [Miniconda website](https://docs.anaconda.com/free/miniconda/) for up-to-date installation instructions if the above instructions don't work for your system.


(installation-methods)=

## Installation methods

SLEAP can be installed three different ways: via {ref}`conda package<condapackage>`, {ref}`conda from source<condasource>`, or {ref}`pip package<pippackage>`. Select one of the methods below to install SLEAP. We recommend {ref}`conda package<condapackage>`.

````{tabs}
`````{tabs}
```{tab} conda package
**This is the recommended installation method**.
````{tabs}
```{group-tab} Windows and Linux
```bash
conda create -y -n sleap -c conda-forge -c nvidia -c sleap -c anaconda sleap=1.4.1a2
```
```
```{note}
- This comes with CUDA to enable GPU support. All you need is to have an NVIDIA GPU and [updated drivers](https://nvidia.com/drivers).
- If you already have CUDA installed on your system, this will not conflict with it.
Expand Down Expand Up @@ -222,7 +221,7 @@ SLEAP can be installed three different ways: via {ref}`conda package<condapackag
````{tabs}
```{group-tab} NVIDIA GPU
```bash
conda create --name sleap pip python=3.7.12 cudatoolkit=11.3 cudnn=8.2
conda create --name sleap pip python=3.7.12 cudatoolkit=11.3 cudnn=8.2 -c conda-forge -c nvidia
```
```
```{group-tab} CPU or other GPU
Expand Down Expand Up @@ -256,7 +255,7 @@ SLEAP can be installed three different ways: via {ref}`conda package<condapackag
```
````
```
````
`````

## Testing that things are working

Expand Down

0 comments on commit a6f65fb

Please sign in to comment.