search

CABLE-LSM / benchcab

Tool for evaluation of CABLE land surface model
https://benchcab.readthedocs.io/en/latest/
Apache License 2.0
2 stars 4 forks source link

Add quick start instructions for users on Gadi #277

Closed SeanBryan51 closed 6 months ago

SeanBryan51 commented 7 months ago

It would be useful to have all the instructions needed to run benchcab on Gadi without having to read the full explanation of each step in the documentation as this will be clearer for users to get started (see #276).

For example, we could have the following as the first section in the README or the main documentation:

Quickstart

To launch a benchcab run, execute the following in the command line:

module use /g/data/hh5/public/modules
module load conda/analysis3-unstable
cd /scratch/$PROJECT/$USER
git clone https://github.com/CABLE-LSM/bench_example.git
cd bench_example
benchcab run
ccarouge commented 7 months ago

Maybe add the manual edit of the config file to the list of commands?

module use /g/data/hh5/public/modules
module load conda/analysis3-unstable
cd /scratch/$PROJECT/$USER
git clone https://github.com/CABLE-LSM/bench_example.git
cd bench_example
# Edit config.yaml to your liking
vim config.yaml
benchcab run