Installation Guide#

First said, this software application is pre-release and may contain significant unhandled bugs. Please report any issues you encounter (BCDA-APS/gemviz#new) or feature requests, too.

Suggested installation for developers is to use pip with its editable mode:

This project is still in development. We have plans for production release (BCDA-APS/projects#6). Until the production release, you should run gemviz as would a developer by following these (Linux) instructions:

Navigate to a directory where you have similar software projects
git clone https://github.com/BCDA-APS/gemviz - only need to do this once, assumes you have git command
cd gemviz
conda env create --force -n gemviz -f ./env.yml - only need to do this once, assumes you have conda command
conda activate gemviz
pip install -e .
gemviz &