Installation 

DIPLOMAT currently supports being installed as a normal python package on Windows, Linux, and MacOS. DIPLOMAT and can be installed by following the installation guide below.

Contents

Installation
- Installing Python
- Installing DIPLOMAT
  - With Support for DeepLabCut Projects
    - Using Conda or Miniconda
    - Using PIP
  - With Support for SLEAP Projects
    - Using Conda or Miniconda
    - Using PIP

Installing Python 

If you have not already, you’ll need to install python to utilize DIPLOMAT. It is recommend that you use Miniconda which provides a python environment and install process that is consistent across platforms. To install miniconda:

Visit https://docs.conda.io/en/latest/miniconda.html.

Select the installer for your OS from the list of installers.

Run the installer and follow the installation instructions.

Installing DIPLOMAT 

With Support for DeepLabCut Projects 

Using Conda or Miniconda 

Once you have a anaconda installed, you’ll want to open a terminal and type:

conda env create -f https://raw.githubusercontent.com/TravisWheelerLab/DIPLOMAT/main/conda-environments/DIPLOMAT-DEEPLABCUT.yaml

Hint

Both running and installing diplomat requires access to a terminal. To access one:

Windows: Open the start menu and search for Anaconda Command Prompt. If a program by that name is not found, search for Command Prompt.

Linux: Press CTRL + ALT + T. This will open a terminal window.

Mac: Select the search icon in the top right corner of the screen to open Spotlight, and then search for Terminal.

Once done, simply activate the brand new environment.

conda activate DIPLOMAT-DEEPLABCUT

From here, the diplomat command will be available from the command line.

Using PIP 

If you are using an alternative package for managing python environments, you can install DIPLOMAT with DeepLabCut support by simply using pip, using one of the two commands below:

# Install DIPLOMAT with DeepLabCut with GUI support.
pip install "diplomat-track[dlc, gui] @ git+https://github.com/TravisWheelerLab/DIPLOMAT.git"
# Install DIPLOMAT with DeepLabCut without UI support.
pip install "diplomat-track[dlc] @ git+https://github.com/TravisWheelerLab/DIPLOMAT.git"

With Support for SLEAP Projects 