Metadata-Version: 2.4
Name: ethology
Version: 0.0.4
Summary: Data processing tools for animal behavioural analysis
Author-email: Adam Tyson <code@adamltyson.com>
License: BSD-3-Clause
Project-URL: Homepage, https://github.com/neuroinformatics-unit/ethology
Project-URL: Bug Tracker, https://github.com/neuroinformatics-unit/ethology/issues
Project-URL: Documentation, https://github.com/neuroinformatics-unit/ethology
Project-URL: Source Code, https://github.com/neuroinformatics-unit/ethology
Project-URL: User Support, https://github.com/neuroinformatics-unit/ethology/issues
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Operating System :: OS Independent
Classifier: License :: OSI Approved :: BSD License
Requires-Python: >=3.10.0
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: movement
Requires-Dist: pandera[pandas]
Provides-Extra: dev
Requires-Dist: pytest; extra == "dev"
Requires-Dist: pytest-cov; extra == "dev"
Requires-Dist: coverage; extra == "dev"
Requires-Dist: tox; extra == "dev"
Requires-Dist: mypy; extra == "dev"
Requires-Dist: pre-commit; extra == "dev"
Requires-Dist: ruff; extra == "dev"
Requires-Dist: codespell; extra == "dev"
Requires-Dist: setuptools_scm; extra == "dev"
Requires-Dist: pandas-stubs; extra == "dev"
Requires-Dist: types-attrs; extra == "dev"
Requires-Dist: check-manifest; extra == "dev"
Requires-Dist: types-PyYAML; extra == "dev"
Requires-Dist: types-requests; extra == "dev"
Dynamic: license-file

[![Python Version](https://img.shields.io/pypi/pyversions/ethology.svg)](https://pypi.org/project/ethology)
[![PyPI Version](https://img.shields.io/pypi/v/ethology.svg)](https://pypi.org/project/ethology)
[![License](https://img.shields.io/badge/License-BSD_3--Clause-orange.svg)](https://opensource.org/licenses/BSD-3-Clause)
[![CI](https://img.shields.io/github/actions/workflow/status/neuroinformatics-unit/ethology/test_and_deploy.yml?label=CI)](https://github.com/neuroinformatics-unit/ethology/actions)
[![Code style: Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/format.json)](https://github.com/astral-sh/ruff)
[![codecov](https://codecov.io/gh/neuroinformatics-unit/ethology/branch/main/graph/badge.svg?token=P8CCH3TI8K)](https://codecov.io/gh/neuroinformatics-unit/ethology)
[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit)
[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/neuroinformatics-unit/ethology/main.svg)](https://results.pre-commit.ci/latest/github/neuroinformatics-unit/ethology/main)

# ethology


## Quick install

First clone the repository at the desired location:
```bash
git clone https://github.com/neuroinformatics-unit/ethology.git
```

Then create a conda environment and install the package from source
```sh
conda create -n ethology-env python=3.12 -y
conda activate ethology-env
cd ethology
pip install .
```

For more information please check our [documentation](https://ethology.neuroinformatics.dev).

Contributions and feature requests are more than welcome! Have a look at our [Contributing guidelines](community/contributing.rst) and feel to [open an issue](https://github.com/neuroinformatics-unit/ethology/issues) to report a bug or request a new feature.
