Installation and updating - galizia-lab/pyview GitHub Wiki

This page contains information about installing and updating VIEW. There are two ways of installing/ updating VIEW.

  1. As a normal user (quick and easy)
  1. As a developer (more involved)

Installing VIEW as a normal user

In Short

  1. Install Anaconda
  2. Create an environment
  3. Install VIEW
  4. You're done!

Installing VIEW

  1. Open terminal or Anaconda Powershell.
  2. Activate the environment created above, using conda activate view_py310
  3. [Recommended] Take note of the latest tag of VIEW from here.
  4. Install view by typing the following (replace <tag name> with the latest tag, e.g.: 0.8.9)

pip install git+https://[email protected]/galizia-lab/pyview.git@<tag name>

[advanced] You could also install the latest developmental version of VIEW which might have minor issues:

pip install git+https://[email protected]/galizia-lab/pyview.git@master

You have successfully installed VIEW!

Updating VIEW

  1. Open terminal or Anaconda Powershell.
  2. Activate the environment created above, using conda activate view_py310
  3. Take note of the latest tag of VIEW from here. Install view by typing the following (replace <tag name> with the latest tag, e.g.: 0.8.9) pip install git+https://[email protected]/galizia-lab/pyview.git@<tag name> [advanced] current development version: pip install git+https://[email protected]/galizia-lab/pyview.git@master 
NOTE:
---
For VIEW version 0.8.11 and above, each version of VIEW is tied to particular versions of Tillvisionio and ILTIS. This means that if newer versions are installed, they will be downgraded to the version specified by VIEW. Take care!

You have updated successfully VIEW to a new version!

Installing as a developer

In Short

  1. Install Anaconda
  2. Download the source code
  3. Create an environment
  4. Install VIEW
  5. (optional) Install ILTIS and tillvisionio
  6. You're done!

Step 1: Download and organize source code

  1. Create a folder for organizing the source code of VIEW and projects on which it depends.
  2. Open a terminal/Powershell and navigate into the newly created folder and clone the source code of the following repositories:

Each command will create a new folder called "view" or "iltis" or "tillvisionio". These folders contains the source code of different repositories.

Step 2: Creating a python environment

Follow instructions here, but instead using the conda file "conda_py310_dev_***.yml"

Step 3: Installing view

  1. Open a terminal/Powershell.
  2. Activate the environment view created above, for example using conda activate <environment name>
  3. Navigate into the folder containing the source code of view (for example: cd <drag the folder 'tillvisionio' here from file explorer>). This folder was created in Step 1 above. Check that this folder contains the file setup.py by typing "ls" and then pressing enter.
  4. Check the available tags either by checking "Repository"->"Tags" (on the left panel) or using the command git tag in Powershell.
  5. Checkout a version you want to install using the command git checkout <tag-name>. Using the latest tag is recommended. You have successfully switched to the latest tag if you see the output Note: switching to ..... Head is now at ......(If no tags exist, checkout the master using git checkout master.)
  6. Install view in developer mode: pip install -e . (Note the "." at the end)
    (NOTES: (1) you might be prompted, multiple times, for your password associated with your ssh key for gitlab.inf.uni-konstanz.de (2) If you get an error at this stage saying "failed to verify SSL certificate", try to do pip install setuptools-scm first and then pip install .)
  7. You have successfully installed view in developer mode!

Step 4: Install ILTIS and tillvisionio in developer mode

Repeat the same procedure as you did above for install VIEW, except, by navigating into the folder "iltis" or "tillvisio". It is important to install these two in developer mode (i.e., using pip install -e .) after VIEW as view will automatically download and install versions of ILTIS and tillvisionio specified in its setup.py during installation,

Updating to latest version as a developer

VIEW is being developed together with ILTIS and tillvisionio. Please update ILTIS and tillvisionio whenever you update VIEW, so as to avoid issues due to compatibility.

Updating ILTIS as a developer

  1. Activate the environment created above, for example using conda activate <environment name> or pipenv shell
  2. Navigate into the folder containing the source code. cd <drag the folder 'iltis' here from file explorer>. This folder was created above. Check that this folder contains the file setup.py.
  3. Checkout your master branch. git checkout master. This is required for the next step.
  4. Update your repository to changes from remote: git pull origin master --tags. If the output of this command is "Already up to date", no updates are available and you can skip the remaining steps.
  5. Check the available tags either by checking "Repository"->"Tags" (on the left panel) or using the command git tag in Powershell.
  6. Checkout a version you want to install using the command git checkout <tag-name>. Using the latest tag is recommended. You have successfully switched to the latest tag if you see the output Note: switching to ..... Head is now at ......(If no tags exist, checkout the master using git checkout master.)
  7. Update the installation of ILTIS in your environment pip install -U ./
    NOTE: you might be prompted, multiple times, for your password associated with your ssh key for gitlab.inf.uni-konstanz.de

Updating tillvisionio

Repeat the same steps as for updating ILTIS above but by navigating into the folder "tillvisionio".

Updating tillvisionio as as developer

Repeat the same steps as for updating ILTIS above but by navigating into the folder "tillvisionio".

Updating VIEW as a developer

Repeat the same steps as for updating ILTIS above but by navigating into the folder "view".

⚠️ **GitHub.com Fallback** ⚠️