getting_started.rst

Getting Started

Instructions for SHIVER development

Conda Configuration

Create and activate conda environment for SHIVER.

conda env create --file environment.yml
# or
mamba env create --file environment.yml

conda activate shiver

Install SHIVER (in editable mode) and start application

python -m pip install -e .

shiver

If it has been a while, once can update using

conda activate shiver
conda env update --file environment.yml --prune

To start SHIVER from within the Mantid workbench, start mantidworkbench then run the following in the IPython console

from shiver import Shiver
s = Shiver()
s.show()

For Developers

To run all tests for SHIVER

pytest
#or
python -m pytest

To run pre-commit manually

pre-commit run --all-files

Or to set the pre-commit hook before each git commit

pre-commit install