Metadata-Version: 2.1
Name: ParticleDetection
Version: 0.4.2.dev38
Summary: Tools to track particles with machine learning.
Home-page: https://github.com/ANP-Granular/ParticleTracking
Author: Adrian Niemann
Author-email: adrian.niemann@gmx.de
Requires-Python: >=3.8,<3.13
Classifier: Environment :: GPU :: NVIDIA CUDA
Classifier: Intended Audience :: Science/Research
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Classifier: Topic :: Scientific/Engineering :: Image Processing
Classifier: Topic :: Scientific/Engineering :: Physics
Provides-Extra: detectron
Provides-Extra: test
Requires-Dist: Pillow (>=10) ; extra == "detectron"
Requires-Dist: importlib-resources (>=6.1) ; (python_version < "3.9") and (extra == "test")
Requires-Dist: matplotlib (>=3.6.1,<3.8) ; python_version < "3.9"
Requires-Dist: matplotlib (>=3.8) ; python_version >= "3.9"
Requires-Dist: networkx (>=3.1)
Requires-Dist: numpy (>=1.21,<=1.25) ; python_version < "3.9"
Requires-Dist: numpy (>=1.23.4,<2) ; python_version >= "3.9"
Requires-Dist: opencv-python-headless (>=4.8.1.78)
Requires-Dist: pandas (<2.1) ; python_version < "3.9"
Requires-Dist: pandas (>=2.1.1) ; python_version >= "3.9"
Requires-Dist: protobuf (==3.20.1) ; extra == "detectron"
Requires-Dist: pulp (>=2.7.0)
Requires-Dist: pytest (>=7.4.2) ; extra == "test"
Requires-Dist: pytest-cov (>=4.1.0) ; extra == "test"
Requires-Dist: scikit-image (>=0.21.0,<0.22) ; python_version < "3.9"
Requires-Dist: scikit-image (>=0.22.0) ; python_version >= "3.9"
Requires-Dist: scikit-learn (>=1.3.1)
Requires-Dist: scipy (<1.11.0) ; python_version < "3.9"
Requires-Dist: scipy (>=1.9.3,!=1.13.0) ; python_version >= "3.9"
Requires-Dist: tensorboard ; extra == "detectron"
Requires-Dist: torch (>=2)
Requires-Dist: torchaudio (>=2)
Requires-Dist: torchvision (>=0.14.0)
Requires-Dist: tqdm (>=4.64.1)
Requires-Dist: trackpy (>=0.6.1)
Project-URL: Documentation, https://particletracking.readthedocs.io/
Project-URL: Repository, https://github.com/ANP-Granular/ParticleTracking
Description-Content-Type: text/markdown

# Particle Detection
This repository customizes the training, inference and visualization code of the **Detectron2** framework to accurately detect rod-like particles. It additionally provides functionality to track these detected particles over multiple frames and reconstruct 3D representations of these observed granular gases.

![Rod Detection Output Image](https://user-images.githubusercontent.com/34780470/214838680-4474e35c-4277-4ac9-8649-3940aa122eeb.jpg)

Please refer to the [documentation](https://particletracking.readthedocs.io/en/stable/index.html) for more detailed information.

## Installation
Install the default version using pip:
```shell
pip install ParticleDetection
```
Or use one of the options described in the [documentation](https://particletracking.readthedocs.io/en/stable/installation/particledetection.html). **Some options require manual installation of additional libraries.**
```shell
pip install ParticleDetection[OPTION]
```

It is also possible to install it directly from GitHub:
```shell
pip install 'git+https://github.com/ANP-Granular/ParticleTracking.git#egg=particledetection&subdirectory=ParticleDetection'
```
```shell
pip install 'particledetection[DETECTRON] @ git+https://github.com/ANP-Granular/ParticleTracking.git#egg=
particledetection&subdirectory=ParticleDetection'
```

