Software installation

Supported Operating Systems

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

1. Create and activate a python environment using venv or Conda.

   • Using venv

     GlowTracker requires python version of at least 3.10. If you do not have one, please download from [Python].

     1. Create the environment

         python -m venv glowtracker
        

     2. Activate the environment

         source glowtracker/Scripts/activate
        

   • Using Conda

     1. Install Conda [Link]
     2. Use conda to create a new python environment named glowtracker.

         conda create -n glowtracker "python>=3.10,<3.12"
        

     3. Activate the glowtracker environment

         conda activate glowtracker
        

2. Install the glowtracker package.
   • Using pip to install from PyPI repository:

       python -m 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;
         conda env update --file glowtracker/StageEnvironment.yml --prune
        

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

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

5. 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