diff --git a/.github/workflows/website.yml b/.github/workflows/website.yml index ede9eef9f..830788388 100644 --- a/.github/workflows/website.yml +++ b/.github/workflows/website.yml @@ -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" diff --git a/docs/installation.md b/docs/installation.md index 4799a0893..d926c724a 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -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). ``` @@ -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: @@ -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`, {ref}`conda from source`, or {ref}`pip package`. Select one of the methods below to install SLEAP. We recommend {ref}`conda package`. -````{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. @@ -222,7 +221,7 @@ SLEAP can be installed three different ways: via {ref}`conda package