Metadata-Version: 2.4
Name: boris-behav-obs
Version: 10.0.1
Summary: BORIS - Behavioral Observation Research Interactive Software
Author-email: Olivier Friard <olivier.friard@unito.it>
License-Expression: GPL-3.0-only
Project-URL: Homepage, http://www.boris.unito.it
Project-URL: Documentation, https://www.boris.unito.it/user_guide/
Project-URL: Change_log, https://github.com/olivierfriard/BORIS/wiki/BORIS-change-log-v.8
Project-URL: Source_code, https://github.com/olivierfriard/BORIS
Project-URL: Issues, https://github.com/olivierfriard/BORIS/issues
Classifier: Topic :: Scientific/Engineering
Classifier: Intended Audience :: Science/Research
Classifier: Intended Audience :: Education
Classifier: Programming Language :: Python :: 3.12
Classifier: Operating System :: OS Independent
Classifier: Topic :: Scientific/Engineering
Requires-Python: <3.14,>=3.13
Description-Content-Type: text/markdown
License-File: LICENSE.TXT
Requires-Dist: exifread==3.5.1
Requires-Dist: numpy==2.3.2
Requires-Dist: matplotlib==3.10.5
Requires-Dist: pandas==2.3.2
Requires-Dist: tablib[cli,html,ods,pandas,xls,xlsx]==3.8.0
Requires-Dist: pyreadr==0.5.3
Requires-Dist: pyside6==6.10
Requires-Dist: pyobjc-framework-Cocoa; sys_platform == "darwin"
Requires-Dist: hachoir==3.3.0
Requires-Dist: scipy==1.16.1
Requires-Dist: scikit-learn==1.7.1
Requires-Dist: pyqtgraph>=0.14.0
Requires-Dist: pytest-cov==7.1.0
Requires-Dist: pytest==9.1.1
Provides-Extra: dev
Requires-Dist: ruff; extra == "dev"
Requires-Dist: pytest; extra == "dev"
Requires-Dist: pytest-cov; extra == "dev"
Provides-Extra: r
Requires-Dist: rpy2>=3.6.1; extra == "r"
Dynamic: license-file

BORIS (Behavioral Observation Research Interactive Software)
===============================================================


![BORIS logo](https://github.com/olivierfriard/BORIS/blob/master/boris/icons/logo_boris.png?raw=true)

BORIS is an easy-to-use event logging software for video/audio coding or live observations.

BORIS is a free and open-source software available for GNU/Linux, Windows and macOS.

It provides also some analysis tools like time budget and some plotting functions.

### Video playback on macOS

On macOS, BORIS displays video inside its player panels using libmpv and OpenGL.
Install mpv (including libmpv) and FFmpeg with Homebrew:

```
brew install mpv ffmpeg
```

If libmpv is unavailable, BORIS uses separate mpv windows through IPC. This mode
can also be selected with `--ipc` (`-i`). IPC diagnostic messages are written to
`/tmp/mpvsocket<N>.log` to prevent unread output pipes from blocking playback.

Panels can be moved, floated, and docked again. Use *Tools > Lock dockwidgets* to
lock them. Hardware decoding set to `auto` or `auto-safe` uses VideoToolbox
copy-back so that frame extraction and geometric measurements remain available.

On macOS, arrow keys reported with the numeric keypad modifier are normalized
for navigation and behavior shortcuts. To show or hide columns in the Ethogram,
Subjects, or Events tables, right-click the table header or choose *Configure
columns* from the table menu. Column visibility is saved between sessions.


The BORIS paper has more than 2931 citations in peer-reviewed scientific publications.




See the official [BORIS web site](https://www.boris.unito.it).

<a href="https://www.boris.unito.it" target="_blank"><img alt="Website" src="https://img.shields.io/website?url=https%3A%2F%2Fwww.boris.unito.it"></a>
<a href="https://www.boris.unito.it/user_guide/" target="_blank"><img alt="User guide" src="https://img.shields.io/badge/Documentation-orange"></a>
[![Python web site](https://img.shields.io/badge/Made%20with-Python-1f425f.svg)](https://www.python.org)
![Python versions](https://img.shields.io/pypi/pyversions/boris-behav-obs)
![BORIS license](https://img.shields.io/pypi/l/boris-behav-obs)
[![PyPI version](https://img.shields.io/pypi/v/boris-behav-obs.svg)](https://pypi.org/project/boris-behav-obs/)

[![Number of downloads](https://static.pepy.tech/personalized-badge/boris-behav-obs?period=total&units=international_system&left_color=black&right_color=orange&left_text=Downloads)](https://pepy.tech/project/boris-behav-obs)
![commit-activity](https://img.shields.io/github/commit-activity/m/olivierfriard/BORIS)
![GitHub last commit](https://img.shields.io/github/last-commit/olivierfriard/BORIS)

![BORIS scopus citations badge](https://penelope.unito.it/friard/boris_scopus_citations.svg)


![GitHub Repo stars](https://img.shields.io/github/stars/olivierfriard/BORIS?style=flat&label=Stars)
[![Please Star](https://img.shields.io/badge/⭐-Star%20this%20repo-blue?style=flat-square)](https://github.com/olivierfriard/BORIS/stargazers)

# Documentation



The [user guide](https://www.boris.unito.it/user_guide/) provides a good starting point for learning how to use BORIS.

Some [video tutorials](https://www.boris.unito.it/video_tutorials/) are available.





# Bug reports and feature requests


To search for bugs, report them or request a feature, please use the [GitHub issues tracker](https://github.com/olivierfriard/BORIS/issues)





# Citing BORIS


Please acknowledge and cite the use of this software and its authors when
results are used in publications or published elsewhere. You can use the
following BibTex entry

```
@article {MEE3:MEE312584,
    author = {Friard, Olivier and Gamba, Marco},
   title = {BORIS: a free, versatile open-source event-logging software for video/audio coding and live observations},
   journal = {Methods in Ecology and Evolution},
   issn = {2041-210X},
   url = {http://dx.doi.org/10.1111/2041-210X.12584},
   doi = {10.1111/2041-210X.12584},
   pages = {1324--1330},
    year = {2016},
}
```

You can also send us a nice postcard! See the [user testimonials](https://www.boris.unito.it/postcards).








# Licence


This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.


Distributed with a [GPL v.3 license](LICENSE.TXT).

Copyright (C) 2012-2025 Olivier Friard
