Installation

Pip

The easiest way is to install ViSiAnnoT with pip:

$ pip install visiannot

You may need to call pip3 instead.

From source

You may install ViSiAnnoT from source:

$ git clone https://github.com/RphWbr/visiannot
$ cd visiannot
$ pip install .

Dependencies

ViSiAnnoT requires Python 3.6+.

It is cross-platform and has been tested on Windows 7/10, Ubuntu 16/18/20 and MacOS Mojave/Catalina.

The following packages are required and are automatically installed with pip:

• configobj (saving and loading configuration files)

• opencv-python (loading video files)

• h5py (loading .h5 files)

• numpy

• PyQt5 (GUI creation)

• pyqtgraph (video and signal plots)

• pytz (date-time comparison with time zone)

• scipy (loading .mat files)

• tinytag (getting video files duration)

Run ViSiAnnoT

Once it is installed, you can launch ViSiAnnoT with the following command line:

$ python3 -m visiannot

First, the configuration GUI will open, see chapter User guide: configuration. Then the ViSiAnnoT GUI will open, see chapter User guide: ViSiAnnoT.

In order to familiarize with ViSiAnnoT, an example of dataset is provided on GitHub. You may download or clone this repository on your computer.

There are several optional arguments, run python3 -m visiannot -h to get help. Below we give some examples on how to use them.

Specify a configuration file to load:

$ python3 -m visiannot -c path/to/config.ini

Disable configuration GUI (only ViSiAnnoT GUI is launched):

$ python3 -m visiannot -c path/to/config.ini -n

Disable ViSiAnnoT GUI (only configuration GUI is launched):

$ python3 -m visiannot -m

Call a function in order to automatically update the configuration before launching the GUIs (see Customization for details):

$ python3 -m visiannot -c path/to/config.ini -u visiannot.configuration.update.update_data_and_annotations_directory