diff --git a/develop/_sources/installation.md b/develop/_sources/installation.md index f9a0431f3..7b7fb46f1 100644 --- a/develop/_sources/installation.md +++ b/develop/_sources/installation.md @@ -2,6 +2,38 @@ SLEAP can be installed as a Python package on Windows, Linux, and Mac OS. +````{tabs} + + ```{group-tab} Windows and Linux + + + ```bash + mamba create -y -n sleap -c conda-forge -c nvidia -c sleap -c anaconda sleap=1.4.1a1 + ``` + + + ```{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. + - This will also work in CPU mode if you don't have a GPU on your machine. + ``` + + ``` + + ```{group-tab} Mac OS + + ```bash + mamba create -y -n sleap -c conda-forge -c anaconda -c sleap sleap=1.4.1a1 + ``` + + ```{note} + This will also work in CPU mode if you don't have a GPU on your machine. + ``` + + ``` + +```` + The newest version of SLEAP can always be found in the [Releases page](https://github.com/talmolab/sleap/releases). ```{contents} Contents diff --git a/develop/_static/css/tabs.css b/develop/_static/css/tabs.css index 5c8708f75..10914e8a4 100644 --- a/develop/_static/css/tabs.css +++ b/develop/_static/css/tabs.css @@ -28,6 +28,10 @@ margin: -1px; background-color: rgb(50, 50, 50); } + + .admonition .sphinx-tabs-tab[aria-selected="true"]:last-child { + margin-bottom: -1px; + } .sphinx-tabs-tab:focus { z-index: 1; diff --git a/develop/docs/_static/css/tabs.css b/develop/docs/_static/css/tabs.css index 5c8708f75..10914e8a4 100644 --- a/develop/docs/_static/css/tabs.css +++ b/develop/docs/_static/css/tabs.css @@ -28,6 +28,10 @@ margin: -1px; background-color: rgb(50, 50, 50); } + + .admonition .sphinx-tabs-tab[aria-selected="true"]:last-child { + margin-bottom: -1px; + } .sphinx-tabs-tab:focus { z-index: 1; diff --git a/develop/installation.html b/develop/installation.html index 86eb4ffa0..dfd6c0462 100644 --- a/develop/installation.html +++ b/develop/installation.html @@ -343,6 +343,26 @@
SLEAP can be installed as a Python package on Windows, Linux, and Mac OS.
+mamba create -y -n sleap -c conda-forge -c nvidia -c sleap -c anaconda sleap=1.4.1a1
+
Note
+This comes with CUDA to enable GPU support. All you need is to have an NVIDIA GPU and updated drivers.
If you already have CUDA installed on your system, this will not conflict with it.
This will also work in CPU mode if you don’t have a GPU on your machine.
mamba create -y -n sleap -c conda-forge -c anaconda -c sleap sleap=1.4.1a1
+
Note
+This will also work in CPU mode if you don’t have a GPU on your machine.
+The newest version of SLEAP can always be found in the Releases page.
Contents
@@ -384,19 +404,19 @@Installation requires entering commands in a terminal. To open one:
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 or Windows Terminal.
Launch a new terminal by pressing Ctrl + Alt + T.
-Launch a new terminal by pressing Cmd + Space and searching for Terminal.
+Launch a new terminal by pressing Ctrl + Alt + T.
+Launch a new terminal by pressing Cmd + Space and searching for Terminal.
This is the recommended installation method.
+This is the recommended installation method.
mamba create -y -n sleap -c conda-forge -c nvidia -c sleap -c anaconda sleap=1.4.1a1
+mamba create -y -n sleap -c conda-forge -c nvidia -c sleap -c anaconda sleap=1.4.1a1
@@ -407,7 +427,7 @@ Installation methodsmamba create -y -n sleap -c conda-forge -c anaconda -c sleap sleap=1.4.1a1
+
mamba create -y -n sleap -c conda-forge -c anaconda -c sleap sleap=1.4.1a1
@@ -415,7 +435,7 @@ Installation methodsThis is the recommended method for development.
+
This is the recommended method for development.
First, ensure git is installed:
git --version
@@ -430,15 +450,15 @@ Installation methods
-
-mamba env create -f environment.yml -n sleap
+
+mamba env create -f environment.yml -n sleap
-mamba env create -f environment_no_cuda.yml -n sleap
+
mamba env create -f environment_no_cuda.yml -n sleap
-mamba env create -f environment_mac.yml -n sleap
+
mamba env create -f environment_mac.yml -n sleap
@@ -451,14 +471,14 @@ Installation methods-n sleap in the command to create an environment with a different name (e.g., -n sleap_develop
).
-This is the recommended method for Google Colab only.
+This is the recommended method for Google Colab only.
Warning
This will uninstall existing libraries and potentially install conflicting ones.
We strongly recommend that you only use this method if you know what you’re doing!
-
+
Note
Requires Python 3.7
@@ -469,10 +489,10 @@ Installation methodspip install sleap:
-mamba create --name sleap pip python=3.7.12 cudatoolkit=11.3 cudnn=8.2
+mamba create --name sleap pip python=3.7.12 cudatoolkit=11.3 cudnn=8.2
-mamba create --name sleap pip python=3.7.12
+
mamba create --name sleap pip python=3.7.12
@@ -503,7 +523,7 @@ Installation methodsNot supported.
+
Not supported.