deepSSF 0.1.1

Deep learning step selection functions for predicting animal movement.

deepSSF

Deep learning step selection functions for predicting animal movement.

This package provides the reusable, installable implementation of the deepSSF method. The accompanying paper, tutorials, and reproducibility code live at the deepSSF project site.

Installation (pip only)

If you manage your own Python environment, install deepSSF with:

pip install deepssf

Development install (editable, with linting and testing tools):

git clone https://github.com/swforrest/deepssf
cd deepssf
pip install -e ".[dev]"

Quick start

import deepssf
print(deepssf.__version__)

Setting up (for users new to Python)

If you are coming from R, think of a conda environment the way you think of an renv project library — it is a self-contained Python installation that keeps this project's packages separate from everything else on your computer. The steps below create one for deepssf and should take about five minutes.

1. Install Miniconda (once, system-wide)

Download and run the installer from the official Miniconda page.

• Windows: use the Anaconda Prompt for all subsequent commands, and choose an install path that contains no spaces (e.g. C:\miniconda3).
• macOS / Linux: a normal terminal works fine.

Miniforge alternative: if you prefer to avoid Anaconda's default channel entirely, Miniforge is a drop-in replacement that ships with conda-forge as the only channel.

2. Create the environment

git clone https://github.com/swforrest/deepssf
cd deepssf
conda env create -f environment.yml

This installs Python 3.11, the geospatial libraries (rasterio / GDAL / PROJ), Jupyter Lab, and the deepSSF package itself with all of its dependencies. PyTorch is installed via pip with no extra flags — pip automatically picks the right build for your hardware: MPS on Apple Silicon, CUDA on NVIDIA GPUs, CPU everywhere else. No configuration is needed; the package selects the correct backend at runtime.

3. Activate the environment

conda activate deepssf

You will need to run this once per terminal session before using deepSSF.

4. (Optional) Register the Jupyter kernel

If you use VS Code or another editor that manages its own Jupyter kernel list, register the environment so it appears as a kernel option:

python -m ipykernel install --user --name deepssf --display-name "Python (deepssf)"

5. Launch Jupyter Lab

jupyter lab

Then open examples/deepssf_train_validate_example.ipynb to get started.

---

Documentation

Tutorials and walkthroughs: https://swforrest.github.io/deepSSF/

Citation

If you use deepssf in your research, please cite the paper. See CITATION.cff or use the citation and link to paper below.

Forrest, S. W., Pagendam, D., Hassan, C., Potts, J. R., Drovandi, C., Bode, M., & Hoskins, A. J. (2026). Predicting animal movement with deepSSF : A deep learning step selection framework. Methods in Ecology and Evolution, 17(2), 371–391. https://doi.org/10.1111/2041-210x.70136

License

MIT — see LICENSE.