Software installation

Supported Operating Systems

• Windows 10, Windows 11
• Ubuntu 16.04 or newer
• macOS Sonoma or newer

1. Create a Python environment using uv (recommend) or venv.
   • Using uv (Recommend)
     1. Install uv [Link].
     2. Create a virtual environment

         uv venv glowtracker.venv
        

   • Using venv
     1. Create the environment

         python -m venv glowtracker.venv
        

2. Activate the environment

    source glowtracker.venv/Scripts/activate
   

3. Install GlowTracker You can choose to either install GlowTracker from a distributed Python package from PyPI or clone the git repository and run them locally.

   • Using pip to install from PyPI repository:

       uv pip install glowtracker
     

   • Or clone and run the package locally.
     1. Clone the pository

         git clone https://github.com/scholz-lab/GlowTracker.git
        

     2. Update the conda environment to download the dependencies

         cd Glowtracker;
         uv pip install -r pyproject.toml;
        

4. Install the BASLER pylon software and runtime library [Link]
   • pylon Camera Software Suite
   • pylon runtime library

5. (Optional) Install Zaber Launcher for inspecting and updating stage firmware [Link]

6. After finished installation, the software can be started in serveral ways
   • If you have installed via pip

       python -m glowtracker
     

     or simply

       glowtracker
     

   • If you have installed by cloning the package and running them locally

       python glowtracker/__main__.py