Skip to content

CryoSiam-Vis Installation Guide

This guide explains how to install cryosiam-vis, a lightweight visualization tool for exploring and inspecting predictions generated by CryoSiam.

CryoSiam-Vis can be installed independently, but it is typically used alongside CryoSiam.


Requirements

  • Python >= 3.8
  • Conda

Step 1: Create the Environment

CryoSiam-Vis uses a predefined Conda environment to ensure that all visualization dependencies are installed with compatible versions.

Create the environment by running:

conda env create -f https://github.com/frosinastojanovska/cryosiam_vis/blob/main/environment.yml

Activate the environment:

conda activate cryosiam_vis

Step 2: Install cryosiam_vis

With the environment activated, clone the CryoSiam-Vis repository:

git clone https://github.com/frosinastojanovska/cryosiam_vis.git
cd cryosiam_vis

Install CryoSiam-Vis into the active environment:

pip install --no-deps .

The --no-deps flag ensures that dependencies provided by Conda are used instead of reinstalling them with pip.


Step 3. Verify the installation

To verify that CryoSiam-Vis was installed correctly, run:

cryosiam_vis --version

Don't Have Conda Installed?

If you do not have Conda installed yet, follow the Conda installation instructions provided in the main CryoSiam installation guide:

Conda installation instructions →


Need Help?

If you encounter issues or unexpected behavior, please open an issue on the CryoSiam-Vis GitHub repository.