Installation#

Tracklib is supported on Python versions 3.8+.

Dependencies#

The following projects are required dependencies of Tracklib:

  • NumPy - NumPy for data arrays access.

  • matplotlib - Used for colormaps and 2D plotting.

  • scikit-image - Used for image processing in Python.

  • progressbar2 - A progress bar to display the progress of a long running operation.

PyPI#

https://img.shields.io/pypi/v/tracklib.svg?logo=python&logoColor=white

Tracklib can be installed from PyPI using pip:

pip install tracklib

Installing the Current Development Branch from GitHub in current environment#

To install tracklib from the latest up-to-date development branch from github, use one of the following:

pip install -U git+https://github.com/umrlastig/tracklib.git@main

Alternatively, you can clone the repository with git and install it with pip.

git clone https://github.com/umrlastig/tracklib.git
cd tracklib
pip install -e .

Installing the Current Development Branch from GitHub in a new python environment#

  1. You may install the latest development version by cloning the GitLab repository:

git clone https://github.com/umrlastig/tracklib.git
cd tracklib
  1. Then you can create a new environment:

[sudo apt-get install python3-venv]
python3 -m venv tracklibenv
source tracklibenv/bin/activate
  1. You have to install required dependencies:

pip install --upgrade pip
pip install wheel
pip install setuptools
pip install twine
  1. You may using pip to install tracklib from the local directory

pip install -e .
python setup.py install
  1. Later, if you want to quit

deactivate

Running test#

If you want to run unit tests, you have to install these dependencies:

pip install pytest
pip install pytest-runner
pip install pytest-benchmark
pip install coverage

Running documentation#

If you want to generate the documentation, you have to install some dependencies are required:

pip install sphinx
pip install recommonmark
pip install sphinx_rtd_theme
pip install sphinx-autodoc-typehints

To launch the documentation:

cd doc
make html

Spyder IDE (development mode)#

A python IDE make the development more easy.

pip install spyder
pip install spyder-kernels
spyder &

To use spyder, you have to create a new project with an existing directory.

../_images/spyder_project.png

Figure 1 - Tracklib project in Spyder#

Make sure the tracklib directory are in the python path of spyder.