Skip to content

Commit

Permalink
Bump to 1.4.1a3
Browse files Browse the repository at this point in the history
  • Loading branch information
roomrys committed Sep 26, 2024
1 parent ef803f6 commit 1d0fe5b
Show file tree
Hide file tree
Showing 4 changed files with 15 additions and 16 deletions.
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Please include information about how you installed.
- OS:
<!-- [e.g. ubuntu 20.04, macOS 11.0] -->
- Version(s):
<!-- e.g. [SLEAP v1.4.1a2, python 3.8] --->
<!-- e.g. [SLEAP v1.4.1a3, python 3.8] --->
- SLEAP installation method (listed [here](https://sleap.ai/installation.html#)):
- [ ] [Conda from package](https://sleap.ai/installation.html#conda-package)
- [ ] [Conda from source](https://sleap.ai/installation.html#conda-from-source)
Expand Down
6 changes: 3 additions & 3 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -28,15 +28,15 @@
copyright = f"2019–{date.today().year}, Talmo Lab"

# The short X.Y version
version = "1.4.1a2"
version = "1.4.1a3"

# Get the sleap version
# with open("../sleap/version.py") as f:
# version_file = f.read()
# version = re.search("\d.+(?=['\"])", version_file).group(0)

# Release should be the full branch name
release = "v1.4.1a2"
release = "v1.4.1a3"

html_title = f"SLEAP ({release})"
html_short_title = "SLEAP"
Expand Down Expand Up @@ -178,7 +178,7 @@ def linkcode_resolve(domain, info):
# These paths are either relative to html_static_path
# or fully qualified paths (eg. https://...)
html_css_files = [
'css/tabs.css',
"css/tabs.css",
]

# Custom sidebar templates, must be a dictionary that maps document names
Expand Down
21 changes: 10 additions & 11 deletions docs/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,12 @@ SLEAP can be installed as a Python package on Windows, Linux, and Mac OS. For qu
````{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
conda create -y -n sleap -c conda-forge -c nvidia -c sleap -c anaconda sleap=1.4.1a3
```
```
```{group-tab} Mac OS
```bash
conda create -y -n sleap -c conda-forge -c anaconda -c sleap sleap=1.4.1a2
conda create -y -n sleap -c conda-forge -c anaconda -c sleap sleap=1.4.1a3
```
```
````
Expand All @@ -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
```
conda create -y -n sleap -c conda-forge -c nvidia -c sleap -c anaconda sleap=1.4.1a3
```
```{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 All @@ -157,7 +156,7 @@ SLEAP can be installed three different ways: via {ref}`conda package<condapackag
```
```{group-tab} Mac OS
```bash
conda create -y -n sleap -c conda-forge -c anaconda -c sleap sleap=1.4.1a2
conda create -y -n sleap -c conda-forge -c anaconda -c sleap sleap=1.4.1a3
```
```{note}
This will also work in CPU mode if you don't have a GPU on your machine.
Expand Down Expand Up @@ -240,7 +239,7 @@ SLEAP can be installed three different ways: via {ref}`conda package<condapackag
```
3. Finally, we can perform the `pip install`:
```bash
pip install sleap[pypi]==1.4.1a2
pip install sleap[pypi]==1.4.1a3
```
```{note}
The pypi distributed package of SLEAP ships with the following extras:
Expand All @@ -256,7 +255,7 @@ SLEAP can be installed three different ways: via {ref}`conda package<condapackag
```
````
```
````
`````

## Testing that things are working

Expand Down
2 changes: 1 addition & 1 deletion sleap/version.py
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
Must be a semver string, "aN" should be appended for alpha releases.
"""

__version__ = "1.4.1a2"
__version__ = "1.4.1a3"


def versions():
Expand Down

0 comments on commit 1d0fe5b

Please sign in to comment.