PyLocator
=========

PyLocator is a Qt-based visualisation tool for inspecting 3-D NIfTI volumes
and annotating EEG electrodes.  The modern port replaces the historic PyGTK
interface with a PySide6/VTK application that runs on contemporary Linux and
Windows systems.

Installation
------------

Create and activate a Python 3.11 virtual environment and install the runtime
dependencies with::

    pip install -r requirements.txt

You can then install PyLocator itself in editable mode while keeping the CLI
entry point available::

    pip install -e .

Running PyLocator
-----------------

Once installed you can start the GUI directly from the command line::

    pylocator <path-to-volume.nii.gz>

When no filename is supplied the application starts with an empty viewport and
provides an **Open…** action to select a NIfTI file.  The status bar and the
volume information dock show basic metadata such as voxel spacing and the value
range of the currently loaded dataset.

Documentation
-------------

The Sphinx documentation that ships with the legacy project is still available
and can be built with::

    python setup.py build_sphinx

The generated HTML pages are written to ``doc/build``.

Development notes
-----------------

The new Qt port deliberately focuses on volume loading and rendering first.
Legacy features such as marker editing, surface visualisation and undo/redo
have not been migrated yet.  Contributions that rebuild these workflows on top
of the modern architecture are very welcome.