BUILDING.md

Building Tomviz

Building Tomviz can be an advanced process that requires ensuring that all necessary dependencies are in place. Most users ought to install Tomviz from the conda-forge packages rather than building it. These instructions are primarily for developers who wish to make contributions.

We install most build dependencies from conda-forge. So it is highly recommended that you make a new conda environment for tomviz, and activating it, like so:

conda create -n tomviz -y
conda activate tomviz

First, we need to ensure that tomviz is cloned into the current repository. Run the following bash code to do so:

if ! [ -e "tomviz" ]; then
  git clone --recursive https://github.com/NSLS2/tomviz
fi

The GitHub Actions CI maintains a list of required dependencies from conda-forge. Thus we will use those lists for installation.

conda install -y --override-channels -c conda-forge --file tomviz/.github/workflows/build_requirements.txt

Now, build Tomviz.

bash tomviz/.github/workflows/scripts/build_tomviz.sh

You can now install all runtime dependencies, as well as the Tomviz python library itself.

conda install -y --override-channels -c conda-forge --file tomviz/.github/workflows/runtime_requirements.txt
pip install --no-build-isolation --no-deps -U tomviz/tomviz/python

Tomviz may then be ran as follows:

./tomviz-build/bin/tomviz

All of the build instructions above put into a single script are as follows:

if ! [ -e "tomviz" ]; then
  git clone --recursive https://github.com/NSLS2/tomviz
fi

# Install build requirements
conda install -y --override-channels -c conda-forge --file tomviz/.github/workflows/build_requirements.txt

# Build Tomviz
bash tomviz/.github/workflows/scripts/build_tomviz.sh

# Install runtime dependencies
conda install -y --override-channels -c conda-forge --file tomviz/.github/workflows/runtime_requirements.txt
pip install --no-build-isolation --no-deps -U tomviz/tomviz/python