Metadata-Version: 2.1
Name: WAZP
Version: 0.1.2
Summary: Wasp Animal-tracking Zoo project with Pose estimation
Author-email: Sofia Miñano <s.minano@ucl.ac.uk>, Nikoloz Sirmpilatze <niko.sirbiladze@gmail.com>, Sam Cunliffe <s.cunliffe@ucl.ac.uk>, Adam Tyson <code@adamltyson.com>
License: BSD-3-Clause
Project-URL: Homepage, https://github.com/SainsburyWellcomeCentre/WAZP
Project-URL: Bug tracker, https://github.com/SainsburyWellcomeCentre/WAZP/issues
Project-URL: Documentation, https://SainsburyWellcomeCentre.github.io/WAZP
Project-URL: Source code, https://github.com/SainsburyWellcomeCentre/WAZP
Project-URL: User support, https://github.com/SainsburyWellcomeCentre/WAZP/issues
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Operating System :: OS Independent
Classifier: License :: OSI Approved :: BSD License
Requires-Python: >=3.9.0
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy
Requires-Dist: pillow
Requires-Dist: pandas
Requires-Dist: dash
Requires-Dist: dash-bootstrap-components
Requires-Dist: dash-player
Requires-Dist: dash-daq
Requires-Dist: opencv-python
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: black ; extra == 'dev'
Requires-Dist: isort ; extra == 'dev'
Requires-Dist: mypy ; extra == 'dev'
Requires-Dist: pre-commit ; extra == 'dev'
Requires-Dist: flake8 ; extra == 'dev'
Requires-Dist: setuptools-scm ; extra == 'dev'
Requires-Dist: types-PyYAML ; extra == 'dev'
Requires-Dist: pandas-stubs ; extra == 'dev'
Requires-Dist: types-Pillow ; extra == 'dev'

[![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/SainsburyWellcomeCentre/WAZP/test_and_deploy.yml?label=CI)
[![docs](https://img.shields.io/website?down_color=red&down_message=down&label=docs&up_color=brightgreen&up_message=up&url=https%3A%2F%2Fsainsburywellcomecentre.github.io%2FWAZP%2F)](https://sainsburywellcomecentre.github.io/WAZP/)
[![Imports: isort](https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336)](https://pycqa.github.io/isort/)
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/python/black)
[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit)

# WAZP 🐝
**W**asp **A**nimal-tracking **Z**oo project with **P**ose estimation
(name is subject to refinement)

## Overview

WAZP is a dashboard built with [Dash-Plotly](https://dash.plotly.com/) for analysing animal tracking data. It can display pose estimation output from [DeepLabCut](https://github.com/DeepLabCut/DeepLabCut).

The package is currently in early development 🏗️ and is not yet ready for use. Stay tuned ⌛

## Installation

We recommend you install WAZP inside a [conda](https://docs.conda.io/en/latest/) environment.
Once you have `conda` installed, the following will create and activate an environment. You can call your environment whatever you like, we've used `wazp-env`.

```sh
conda create -n wazp-env -c conda-forge python=3 pytables
conda activate wazp-env
```

Next install the latest version of WAZP from pip:

```sh
pip install wazp
```

## Launching the dashboard

Once installed, launch the dashboard by running the following command from the root of the repository:

```sh
python wazp/app.py
```

If you're on Linux or MacOS, you can instead run:

```sh
sh start_wazp_server.sh
```

Both commands will launch a local web server. If the dashboard does not automatically open in your default browser, click the link in the terminal to open it (the link will be of the form `http://localhost:8050/`).

## License

⚖️ [BSD 3-Clause](https://opensource.org/licenses/BSD-3-Clause)
