Getting Started

Instructions for GARNET installation and setup.

Create and activate pixi environment for GARNET:

cd /.../garnet
pixi install
pixi shell

This also installs garnet in editable mode with pip, so it can be run immediately:

garnet

If it has been a while and there have been changes to garnet’s pyproject.toml, the environment can be updated by pulling the latest changes and simply reinstalling:

git pull
pixi install

Setup the garnet-data submodule

Open a terminal and go to garnet repository root folder. Run:

git submodule update --init --recursive
git submodule update --remote

This will clone the garnet-data repository in the garnet repository root folder. If for some reason the .gitmodule file is not present, you can add the submodule manually:

git submodule add https://code.ornl.gov/sns-hfir-scse/infrastructure/test-data/garnet-data tests/data/garnet-data

To update to the latest commit for the data-repo. Run:

git submodule update --remote

If the hash for the garnet-data repository has changed and you want to update the hash in the garnet repository, run:

git add tests/data/garnet-data
git commit -m "Update garnet-data to latest commit"
git push

More information on git-lfs can be found in the Neutrons Confluence Git-lfs page.

Checkout out our guide for developers to learn more about coding standards and testing.