Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add quick-start instructions #285

Merged
merged 1 commit into from
Apr 24, 2024
Merged

Add quick-start instructions #285

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions docs/user_guide/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,21 @@ To use `benchcab`, you need to join the following projects at NCI:
- [hh5][hh5_mynci]
- [wd9][wd9_mynci] if not part of the [cable][cable_mynci] project

## Quick-start

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

```sh
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
```

## Installation

The package is already installed for you in the Conda environments under the hh5 project. You simply need to load the module for the conda environment:
Expand Down
Loading