Running GlabTop2-py

This section describes how you can run GlabTop2-py. How-to run the tool depends on the way you have installed GlabTop2-py:

  1. Installation via Anaconda or pip. ONLY the Anaconda installation enables the use of the GlabTop2-py App.

  2. Installation using the download from the GitHub repository.

Select section 1 or 2 below depending on your installation method.

1. Run via Anaconda or pip installation

If you have installed through Anaconda, then you can choose either option A) or option B) below. With pip you can only use option B).

A) Use the App

Before you can use the GlabTop2-py App you need to download the source code from the GlabTop2-py GitHub repository. Once downloaded, only the GlabTop2/app folder is required. Copy this to a location on your hard drive.

Open up a terminal or command line and go inside the copied /app directory. The app can now simply be launched by:

streamlit run main.py

Another option is to create a glabtop2 environment using the environment.yml file, and use run.bat (Windows) or run.sh (Linux/MacOS) to start the App.

B) Command line

If you have installed GlabTop2-py via Anaconda or pip, then you can run GlabTop2-py from any location on your PC; i.e. you do not need to refer to the physical address where the GlabTop2-py source code resides. This is an advantage, because you do not need to copy all the source code files everytime you start a new project.

The steps that are needed to run GlabTop2-py are:

  1. Create a folder somewhere on your hard drive, e.g. c:\my_folder

  2. After you have installed GlabTop2-py via pip, the config.cfg configuration template can be found under:

    PATH-TO-YOUR-PYTHON-INSTALLATION\Lib\site-packages\GlabTop2\config.cfg

    Copy config.cfg to the folder you created under step 1

  3. You can edit the config.cfg and set all the variables in this configuration file

  4. After you have edited and saved config.cfg, you can run GlabTop2-py by:

    python -m GlabTop2.main -i c:\my_folder\config.cfg

2. Run via the GitHub download installation

If you have downloaded the source code from the GlabTop2-py GitHub repository, then you always need to work from the folder where you have extracted GlabTop2-py’s source code files; i.e. every time you start a new project you have to copy the source code files to the new project folder.

The steps that are needed to run GlabTop2-py are:

  1. Create a folder somewhere on your hard drive, e.g. c:\my_folder

  2. Copy all the GlabTop2-py source code files to the folder created under step 1

  3. You can edit the config.cfg and set all the variables in this configuration file

  4. Save the config.cfg file

  5. You can now run GlabTop2-py via:

    python c:\my_folder\main.py -i c:\my_folder\config.cfg