Update guide

Eradiate receives continuous updates. The use of submodules and locked Python dependencies requires some care managing updates. This page provides guidelines to help with this process.

Updating the source code

In the cloned source directory, pull the latest update from GitHub:

git pull

Unfortunately, pulling from the main repository won’t automatically keep the submodules in sync, which can lead to various problems. After pulling the repository itself, it is essential to update the submodules. This is done using the following command in the cloned source directory:

git submodule update --init --recursive

Aliasing the update command for convenience

The following command installs a git alias named pullall that automates these two steps.

git config --global alias.pullall '!f(){ git pull "$@" && git submodule update --init --recursive; }; f'

Afterwards, simply write

git pullall

to fetch the latest version of Eradiate and the appropriate versions of its nested submodules.

The --init flag will ensure that any new submodule will be initialized.

Rebuilding the kernel

After updating, it’s always better to rebuild the kernel:

pixi run build-kernel

Update data files

Optionally, you may want to make sure that the data files you’ll use are up-to-date. For that purpose, you can refresh remote file registries and purge Eradiate’s data cache:

pixi run -e dev eradiate data update-registries
pixi run -e dev eradiate data purge-cache --keep

Note

For a more aggressive cleanup, just run

pixi run -e dev eradiate data purge-cache