.. Track Analyzer - Quantification and visualization of tracking data
    Authors: Arthur Michaut                                                
    Copyright 2016-2019 Harvard Medical School and Brigham and             
                             Women's Hospital                              
    Copyright 2019-2024 Institut Pasteur and CNRS–UMR3738                  
    See the COPYRIGHT file for details                                     
                                                                           
    This file is part of Track Analyzer package.                           
                                                                           
    Track Analyzer is free software: you can redistribute it and/or modify 
    it under the terms of the GNU General Public License as published by   
    the Free Software Foundation, either version 3 of the License, or      
    (at your option) any later version.                                    
                                                                           
    Track Analyzer is distributed in the hope that it will be useful,      
    but WITHOUT ANY WARRANTY; without even the implied warranty of         
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the           
    GNU General Public License for more details .                          
                                                                           
    You should have received a copy of the GNU General Public License      
    along with Track Analyzer (COPYING).                                   
    If not, see <https://www.gnu.org/licenses/>.     

.. _installation:

Installation
============

Galaxy
------

The :doc:`Galaxy interface <galaxy>` runs in a browser and does not require
a local Track Analyzer installation.

Local workflows
---------------

The local workflows require Python 3.11 or newer. The napari plugin requires
napari 0.10 or newer
and a Qt 6 backend. For example, install
`Miniconda <https://docs.conda.io/en/latest/miniconda.html>`_ and create an
environment with PyQt6 in a terminal (or Anaconda PowerShell on Windows):

.. code-block:: sh

    conda create -y -n track-analyzer-napari -c conda-forge python=3.11
    conda activate track-analyzer-napari
    conda install -c conda-forge "napari>=0.10" pyqt6

From the root of the Track Analyzer source checkout, install the plugin and
its dependencies in that same environment:

.. code-block:: sh

    python -m pip install -e ".[napari]"
    python -m napari

This checkout installation also provides the :doc:`notebook` and
:doc:`command_line` workflows. Reactivate the environment before launching
napari or Jupyter in a new terminal.

In napari, open **Plugins > Track Analyzer**. See :doc:`napari` for the plugin
workflow.

If the plugin is missing, verify that napari and Track Analyzer are installed
in the same environment with ``python -m pip show track-analyzer`` and
``python -m pip check``. Reinstall the checkout if napari cannot discover the
plugin entry point.

The checkout contains ``run_TA.ipynb`` and ``example/`` datasets; see
:doc:`examples` for downloadable examples.
