Skip to main content

ethograph

Ethograph demo Labelling in Ethograph

Ethograph is a graphical user interface for visualizing and segmenting multimodal timeseries behavioural data. It builds upon a number of open-source libraries to load and quickly render video and pose files, audio and spectrograms, ephys recordings in various formats, and arbitrary multi-dimensional timeseries — all on one shared timeline.

Note this GUI is still in development. I welcome people testing it and providing feedback!

📖 Documentation

🎥 Watch the demo

Quickstart

First install uv, a fast Python package manager:

# macOS / Linux (except WSL)
curl -LsSf https://astral.sh/uv/install.sh | sh

# Windows
winget install astral-sh.uv

Then install the GUI as a standalone tool — one command, no environment to create or activate:

uv tool install --python 3.12 "ethograph[gui,audio]"

To open the GUI, run:

ethograph check # Linux only : Check for missing libraries
ethograph launch

ethograph not recognized? uv has not added its bin directory to your PATH yet. Run uv tool update-shell, then open a new terminal.

To upgrade later, run the same command with --force --refresh:

uv tool install --python 3.12 --force --refresh "ethograph[gui,audio]"

For installing into a dedicated virtual environment,segmentation models, and troubleshooting, see installation guide.

After launching, there are some example datasets you can explore the GUI with. To learn more about all the functionalities, I recommend the user manual.

Support

Open-source projects Ethograph depends on

Ethograph is built on top of a number of open-source projects: PyAV, audioio, Neo, crowsetta, Neurodata Without Borders, xarray, pynapple, movement, phy, PyQtGraph, and pygfx (via pynaviz). The models that segment behaviour build on DLC2Action, FERAL and E2E-Spot.

Ethograph is GPL-3.0-or-later. The code it vendors or adapts from other projects, and each one's licence, is listed in THIRD_PARTY_NOTICES.md.

Metadata

Release files for ethograph 0.2.51

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for ethograph 0.2.51
File Size Uploaded
ethograph-0.2.51.tar.gz 46.3 MB Details

Built distribution (wheel)

Table of built distributions (wheels) for ethograph 0.2.51
File Interpreter ABI Platform
ethograph-0.2.51-py3-none-any.whl Python 3 none any Details

Total release size: 83.9 MB

Release files / ethograph-0.2.51.tar.gz

Download URL ethograph-0.2.51.tar.gz
Size 46.3 MB
Tags Source
SHA-256 checksum
How to use checksums
dce5f5a89a9ce00a2faae2a22977cfc23e2aca67429fe35a4b7db81d4d9960f6
BLAKE2b-256 checksum
How to use checksums
91a548013599717ac0d9026bc90d8d7ad92a012fe8eab5a07ddea49813c7209f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.13.7

Release files / ethograph-0.2.51-py3-none-any.whl

Download URL ethograph-0.2.51-py3-none-any.whl
Size 37.6 MB
Tags Python 3
SHA-256 checksum
How to use checksums
176fcc4d98767844641a36b23343c5a0ed784166f6e4baa6d3a16c51b22148eb
BLAKE2b-256 checksum
How to use checksums
2d2c85846b35290c308ff7a842b8255531fffd94ebad4c4a5a780615c6ad38d4
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.13.7

Release history Release notifications | RSS feed

0.2.54

2 release files

0.2.53

2 release files

0.2.52

2 release files

This release

0.2.51 This release

2 release files

0.2.50

2 release files

0.2.49

2 release files

0.2.45

2 release files

0.2.44

2 release files

0.2.43

2 release files

0.2.42

2 release files

0.2.41

2 release files

0.2.40

2 release files

0.2.39

2 release files

0.2.38

2 release files

0.2.37

2 release files

0.2.36

2 release files

0.2.35

2 release files

0.2.34

2 release files

0.2.33

2 release files

0.2.24

2 release files

0.2.21

2 release files

0.2.19

2 release files

0.2.18

2 release files

0.2.17

2 release files

0.2.16

2 release files

0.2.15

2 release files

0.2.12

2 release files

0.2.9

2 release files

0.2.8

2 release files

0.2.7

2 release files

0.2.4

2 release files

0.2.3

2 release files

0.2.1

2 release files

0.2.0

2 release files

0.1.19

2 release files

0.1.18

2 release files

0.1.6

2 release files

0.1.5

2 release files

0.1.4

2 release files

0.1.3

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page