Documentation

User guides

User guide (web site)
User guide (PDF)
Video tutorials
Behavioral Analysis with BORIS (Applying Ethology Webinar - 1 hour)
FAQ
A user guide in italian was written by Alessia Macagno and Paola Molina (Dipartimento Interateneo di Scienze, Progetto e Politiche del Territorio from the University of Torino)

BORIS forum of users

A chat platform for BORIS users is available on Gitter (Github or Gitlab or Twitter account required)

Citing litterature

Citations on Scopus (1434 citations at 2023-12-05)
Google Scholar

Development

Bug report and feature request

If you want to report a bug or request a feature, see how to report a bug / request a feature.

Credits

BORIS is developed entirely with open source software.

BORIS is developped in Python 3.10 using PyQt5 for the GUI (should run from Python >= 3.8).
The mpv media player library and the python-mpv interface are used to play media files.
The Matplotlib  python 2D plotting library is used for plotting events and generating the spectrogram.
The Pandas  data analysis tool.
The FFmpeg  multimedia framework is used to extract media files parameters, in frame-by-frame mode and in spectrogram visualization.
The Tablib Python module is used to export data in TSV, CSV, ODS, XLSX, HTML and XLS formats.
The portion Python module is used in the Advanced event filtering function.
The ExifRead Python module used to access pictures Exif data.
The pyreadr Python module is used to save data for R (optionally).
The Graphviz graph visualization software is used (optionally) to generate transitions graph.
The BORIS web site is made using Pelican static site generator and supported by GitHub.