Skip to content

Installation

Requirements

  • Python >=3.8,<3.12
  • Docker (for database setup)
  • Dependencies: numpy, pandas, datajoint, pygame, pillow, and more (automatically installed)

Installation Options

Basic Installation

To install EthoPy with basic features, run:

1
pip install ethopy

This is the preferred method as it will install the most recent stable release.

Optional Features

For additional functionality:

1
2
3
4
5
6
7
8
# For 3D object support
pip install "ethopy[obj]"

# For development
pip install "ethopy[dev]"

# For documentation
pip install "ethopy[docs]"

From Source

To install the latest development version:

1
pip install git+https://github.com/ef-lab/ethopy_package

For development installation:

1
2
3
git clone https://github.com/ef-lab/ethopy_package/.git
cd ethopy
pip install -e ".[dev,docs]"

Database Setup

  1. Start the database container: 

    1
    ethopy-setup-djdocker

  2. Configure the database connection:

Create a configuration file at: - Linux/macOS: ~/.ethopy/local_conf.json - Windows: %USERPROFILE%\.ethopy\local_conf.json

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
{
    "dj_local_conf": {
        "database.host": "127.0.0.1",
        "database.user": "root",
        "database.password": "your_password",
        "database.port": 3306
    },
    "source_path": "/path/to/data",
    "target_path": "/path/to/backup",
    "logging": {
        "level": "INFO",
        "filename": "ethopy.log"
    }
}

  1. Verify database connection: 

    1
    ethopy-db-connection

  2. Create required schemas: 

    1
    ethopy-setup-schema

Raspberry Pi Setup

For detailed Raspberry Pi setup instructions, including hardware-specific configurations and dependencies, please refer to our Raspberry Pi Setup Guide.