Environment¶

Initial Installation¶

Commands¶

Ensure that you have installed Git LFS.
Clone your fork of the repository.
Install Git LFS Git hooks in this repository:
```
git lfs install
```
Ensure that you have installed either pipx or uv for managing Python tools.

Note

If installing Pipx via pip, you will want to use your system Python rather than the current global Python provided by Asdf, Mise, Pyenv, etc…. This is to ensure that a change of global version does not break pipx later.

Ensure that you have installed Copier and Hatch.

If using Pipx:

pipx install copier hatch

If using uv:

uv tool install copier
uv tool install hatch

Install Git pre-commit and pre-push hooks:

hatch --env develop run pre-commit install --config .auxiliary/configuration/pre-commit.yaml

Git Commit Signatures¶

Git commit signatures are required for all contributions to maintain code integrity and authenticity.

Configure Git commit signing by following the GitHub commit signing guide.
If you choose to use SSH keys for Git commit signing, you may want to set up local verification of SSH signatures. See the GitLab documentation on local verification for configuration details (this applies to GitHub repositories as well).

Installation Updates¶

Run:
```
git pull
```
Remove the Hatch virtual environments:
```
hatch env prune
```

Python Interpreter¶

Run:
```
hatch --env develop run python
```

Shell¶

Run:
```
hatch --env develop shell
```