Metadata-Version: 2.4
Name: idtrackerai
Version: 6.0.2
Summary: Idtracker.ai tracks up to 100 unmarked animals from videos recorded in laboratory conditions using artificial intelligence. Free and open source.
Author: Jordi Torrents, Francisco Romero Ferrero, Mattia G. Bergomi, Francisco J.H. Heras, Gonzalo Polavieja
Author-email: Main contact <info@idtracker.ai>
Project-URL: Homepage, https://idtracker.ai/
Project-URL: Repository, https://gitlab.com/polavieja_lab/idtrackerai
Project-URL: Issues, https://gitlab.com/polavieja_lab/idtrackerai/-/issues
Project-URL: Changelog, https://idtracker.ai/latest/user_guide/changelog.html
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: Intended Audience :: Science/Research
Classifier: Intended Audience :: Developers
Classifier: Environment :: X11 Applications :: Qt
Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
Classifier: Operating System :: OS Independent
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: Programming Language :: Python :: 3.13
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy>=1.26.4
Requires-Dist: rich>=13.5.1
Requires-Dist: h5py>=3.10.0
Requires-Dist: scipy>=1.15.0
Requires-Dist: opencv-python-headless>=4.10.0.84
Requires-Dist: pyqt6>=6.7.0
Requires-Dist: qtpy>=2.3.1
Requires-Dist: superqt>=0.7.0
Requires-Dist: toml>=0.10.2
Requires-Dist: matplotlib>=3.7.0
Requires-Dist: packaging
Requires-Dist: psutil>=6.1.0
Requires-Dist: scikit-learn>=1.6.0
Requires-Dist: requests>=2.26.0
Requires-Dist: deprecated>=1.2.13
Provides-Extra: dev
Requires-Dist: pytest; extra == "dev"
Requires-Dist: black[jupyter]; extra == "dev"
Requires-Dist: pylint; extra == "dev"
Requires-Dist: vulture; extra == "dev"
Requires-Dist: isort; extra == "dev"
Requires-Dist: twine; extra == "dev"
Requires-Dist: build; extra == "dev"
Requires-Dist: pre-commit; extra == "dev"
Provides-Extra: docs
Requires-Dist: pydata_sphinx_theme; extra == "docs"
Requires-Dist: sphinx-copybutton; extra == "docs"
Requires-Dist: sphinx_design; extra == "docs"
Requires-Dist: sphinx>=5.0; extra == "docs"
Requires-Dist: nbsphinx; extra == "docs"
Requires-Dist: ipykernel; extra == "docs"
Requires-Dist: sphinx-toolbox; extra == "docs"
Requires-Dist: sphinx-togglebutton; extra == "docs"
Requires-Dist: esbonio; extra == "docs"
Requires-Dist: sphinx-favicon; extra == "docs"
Requires-Dist: torch; extra == "docs"
Requires-Dist: torchvision; extra == "docs"
Dynamic: license-file

<h1 align="center">
<img src="https://gitlab.com/polavieja_lab/idtrackerai/-/raw/master/docs/source/_static/logo_neutral.svg" width="400">
</h1><br>

[![image](http://img.shields.io/pypi/v/idtrackerai.svg)](https://pypi.python.org/pypi/idtrackerai/)
![pipeline](https://gitlab.com/polavieja_lab/idtrackerai/badges/master/pipeline.svg)
[![Documentation Status](https://readthedocs.org/projects/idtrackerai/badge/?version=latest)](https://idtracker.ai/)
[![Supported Python versions](https://img.shields.io/pypi/pyversions/idtrackerai.svg?logo=python&logoColor=FFE873)](https://pypi.org/project/idtrackerai/)
[![PyPI downloads](https://img.shields.io/pypi/dm/idtrackerai.svg)](https://pypistats.org/packages/idtrackerai)
![Licence](https://img.shields.io/gitlab/license/polavieja_lab/idtrackerai.svg)
[![Nature Paper](https://img.shields.io/badge/DOI-10.1038%2Fs41592--018--0295--5-blue)](
https://doi.org/10.1038/s41592-018-0295-5)


*idtracker.ai tracks up to 100 unmarked animals from videos recorded in laboratory conditions using artificial intelligence. Free and open source.*

This work has been published in [Nature Methods](https://doi.org/10.1038/s41592-018-0295-5) ([pdf here](https://drive.google.com/file/d/1fYBcmH6PPlwy0AQcr4D0iS2Qd-r7xU9n/view)), please include the following reference if you use this software in your research:

- ``` plain
  Romero-Ferrero, F., Bergomi, M.G., Hinz, R.C., Heras, F.J.H., de Polavieja, G.G., idtracker.ai: tracking all individuals in small or large collectives of unmarked animals. Nature Methods 16, 179 (2019).
    ```
- ``` bibtex
  @article{idtrackerai2019,
            title={idtracker.ai: tracking all individuals in small or large collectives of unmarked animals},
            author={Romero-Ferrero, Francisco and Bergomi, Mattia G and Hinz, Robert C and Heras, Francisco JH and de Polavieja, Gonzalo G},
            journal={Nature methods},
            volume={16},
            number={2},
            pages={179--182},
            year={2019},
            publisher={Nature Publishing Group US New York}
        }
   ```

Visit [our website](https://idtracker.ai) to find more information about the software, installation instructions, and user guides.

## Installation for developers

On an environment with Python>=3.10 and a working installation of Pytorch (Torch and Torchvision) you can install the latest published idtracker.ai version by installing directly form the GitLab repo:

``` bash
pip install git+https://gitlab.com/polavieja_lab/idtrackerai
```

Or install the developing version from the develop branch:

``` bash
pip install git+https://gitlab.com/polavieja_lab/idtrackerai@develop
```


There exist two extra dependencies options:
 - ``dev`` to install tools for formatting, static analysis, building, publishing, etc.
 - ``docs`` to install needed packages to build documentation (sphinx and some plugins).

## Contributors
* Jordi Torrents (2022-)
* Tiago Costa (2024)
* Antonio Ortega (2021-2023)
* Francisco Romero-Ferrero (2015-2022)
* Mattia G. Bergomi (2015-2018)
* Ricardo Ribeiro (2018-2020)
* Francisco J.H. Heras (2015-2022)

***

For more information please send an email (info@idtracker.ai) or use the tools available at https://gitlab.com/polavieja_lab/idtrackerai.
