Skip to content

installation.md

Latest commit

 

History

History
65 lines (53 loc) · 4.35 KB

installation.md

File metadata and controls

65 lines (53 loc) · 4.35 KB
Raw

Installation

Brief version

  • Install Anaconda
  • Create a new anaconda environment: conda create --name deg python=3.7
  • Activate your environment: conda activate deg
  • Install PySide2: conda install -c conda-forge pyside2==5.13.2
  • Install PyTorch: Use this link for official instructions.
  • pip install deepethogram.

Installing from source

  • git clone https://github.com/jbohnslav/deepethogram.git
  • cd deepethogram
  • conda env create -f environment.yml
    • Be prepared to wait a long time!! On mechanical hard drives, this may take 5-10 minutes (or more). Interrupting here will cause installation to fail.
  • conda activate deg
  • python setup.py develop

Installing Anaconda

For instructions on installing anaconda, please use this link. This will install Python, some basic dependencies, and install the Anaconda package manager. This will ensure that if you use some other project that (say) requires Python 2, you can have both installed on your machine without interference.

  • First things first, download and install Anaconda for your operating system. You can find the downloads here. Make sure you pick the Python 3.7 version. When you're installing, make sure you pick the option something along the lines of "add anaconda to path". That way, you can use conda on the command line.
  • Install git for your operating system (a good idea anyway!) Downloads page here
  • Open up the command line, such as terminal on mac or cmd.exe. VERY IMPORTANT: On Windows, make sure you run the command prompt as an administrator! To do this, right click the shortcut to the command prompt, click run as administrator, then say yes to whatever pops up.

Installing from pip

First install the latest version of PyTorch for your system. Use this link for official instructions. It should be as simple as conda install pytorch torchvision cudatoolkit=10.2 -c pytorch.

Note: if you have an RTX3000 series graphics card, such as a 3060 or 3090, please use cudatoolkit=11.1 or higher.

After installing PyTorch, simply use pip install deepethogram.

Install FFMPEG

We use FFMPEG for reading and writing .mp4 files (with libx264 encoding). Please use this link to install on your system.

Startup

  • conda activate deg. This activates the environment.
  • type python -m deepethogram, in the command line to open the GUI.

Upgrading to Beta

Please see the beta docs for instructions

Common installation problems

  • You might have dependency issues with other packages you've installed. Please make a new anaconda or miniconda environment with conda create --name deg python=3.8 before installation.
  • module not found: PySide2. Some versions of PySide2 install poorly from pip. use pip uninstall pyside2, then conda install -c conda-forge pyside2
  • When opening the GUI, you might get Segmentation fault (core dumped). In this case; please pip uninstall pyside2, conda uninstall pyside2. pip install pyside2
  • ImportError: C:\Users\jbohn\.conda\envs\deg2\lib\site-packages\shiboken2\libshiboken does not exist
    • something went wrong with your PySide2 installation, likely on Windows.
    • Make sure you have opened your command prompt as administrator
    • If it tells you to install a new version of Visual Studio C++, please do that.
    • Now you should be set up: let's reinstall PySide2 and libshiboken.
    • pip install --force-reinstall pyside2
  • _init_pyside_extension is not defined
    • This is an issue where Shiboken and PySide2 are not playing nicely together. Please pip uninstall pyside2 and conda remove pyside2. Don't manually install these packages; instead, let DeepEthogram install it for you via pip. Therefore, pip uninstall deepethogram and pip install deepethogram.
  • qt.qpa.plugin: Could not load the Qt platform plugin "xcb" in ".../python3.8/site-packages/cv2/qt/plugins" even though it was found. This application failed to start because no Qt platform plugin could be initialized. Reinstalling the application may fix this problem.
    • This is an issue with a recent version of opencv-python not working well with Qt. Please do pip install --force-reinstall opencv-python-headless==4.1.2.30