Add documentation for building, running and testing benchcab

[abhaasgoyal]

Building

Dependencies

• conda env

Dev-Dependencies

• black, ruff

module load conda
conda env create --name benchcab-dev --file .conda/benchcab-dev.yaml
conda activate benchcab-dev
pip install --user -e .

• mkdocs

pip install -r mkdocs-requirements.txt

If using on Gadi, use ssh port forwarding

ssh -L 8000:localhost:8000 <username>@gadi.nci.org.au

mkdocs serve

Running

Follow the user guide

Testing

• pytest, mypy
• Integration tests

  /bin/bash benchcab/data/test/integration.sh

Comparing Models

• netcdf, cdo

Tips

Add a docstring using numpy style. (autodocstring extension in VS Code can pre-populate for you, make sure to select numpy style on settings first).

[SeanBryan51]

I think we use nccmp for doing bitwise comparisons between model outputs. I don't think we use cdo?

[abhaasgoyal]

@ccarouge could you clarify which module we use for doing bitwise comparisons, and what's the corresponding command?