INSTALLATION.md

Installation Instructions

Installation from precompiled packages [recommended]

• Download python 3.6>= using anaconda or miniconda if you prefer a lighter installation.
• Open a Terminal in OSX or Linux. In Windows you need to open the Anaconda Prompt.
• [Optional] I would recommend to create and activate an enviroment as:

conda create -n tierpsy 

conda activate tierpsy #[Windows]
source activate tierpsy #[OSX or Linux]

• Finally, donwload the package from conda-forge

conda install tierpsy -c conda-forge

• After you can start tierpsy tracker by typing:

tierpsy_gui

Do not forget to activate the enviroment every time you start a new terminal session.

On OSX the first time tierpsy_gui is intialized it will create a file in the Desktop called tierpsy_gui.command. By double-cliking on this file tierpsy can be started without having to open a terminal.

Troubleshooting

• When installing from conda, you may get an error while the package conda-forge::cloudpickle... is installed, stating that python3.6 couldn't be found. In this case, make sure to first install python 3.6, and then tierpsy, by executing:

conda install -c conda-forge python=3.6
conda install -c conda-forge tierpsy

• It seems that there might be some problems with some opencv versions available through conda. If you have problems reading video files or encounter error related with import cv2, then you can try to install opencv using pip as:

pip install opencv-python-headless

or specify the opencv version via:

conda install opencv=3.4.2 #[tested on MacOS]

• In Windows, the default anaconda channel does not have a valid ffmpeg version. Activate the tierpsy enviroment and use the conda-forge channel instead as:

conda install -c conda-forge ffmpeg

Installation from source [for development]

• Download Python >= 3.6 using anaconda or miniconda.

• Install git. Here are some instructions to install it.

• Install a C compiler compatible with cython. In Windows, you can use Visual C++ 2015 Build Tools. In OSX, if you install homebrew it will setup the C compiler without the need to download XCode from the appstore.

• Open a Terminal or Anaconda prompt and type:

git clone https://github.com/ver228/tierpsy-tracker
cd tierpsy-tracker
conda create -n tierpsy #[optional]
source activate tierpsy #[optional]
conda install --file requirements.txt
pip install -e .

Batch processing from the command line.

The script TierpsyTrackerConsole.py was deprecated in favor of using the command tierpsy_process. Type tierpsy_process -h for help.

Tests

After installing you can run the testing scripts using the command tierpsy_tests on the terminal. Type tierpsy_tests -h for help. Although the script supports running multiple tests consecutively, I would recommed to run one test at the time since there is not currently a way to summarize the results of several tests.