Skip to content

Commit

Permalink
(#319) - formatting
Browse files Browse the repository at this point in the history
  • Loading branch information
ccarouge committed Jan 22, 2025
1 parent cec78fd commit 01dbc88
Showing 1 changed file with 15 additions and 15 deletions.
30 changes: 15 additions & 15 deletions docs/user_guide/use_cases.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,10 +53,10 @@ modules: [
]
```

1. Use the same option names and values as implemented in the cable namelist file.
1. Use the option names and values as implemented in the cable namelist file.
2. You need to setup your environment for meorg_client before using this feature.

The evaluation results will be in modelevaluation.org on the Model Output page you've specified
The evaluation results will be on modelevaluation.org accessible from the Model Output page you've specified

## Evaluate the effect of a modified feature

Expand All @@ -77,13 +77,13 @@ realisations:
- repo:
git:
branch: XXXXX
patch: # (1)
patch: # (2)
cable:
cable_user:
existing_feature: YYYY

fluxsite:
meorg_model_output_id: ZZZZ # (2)
meorg_model_output_id: ZZZZ # (3)

modules: [
intel-compiler/2021.1.1,
Expand All @@ -92,10 +92,11 @@ modules: [
]
```

1. Use the same option names and values as implemented in the cable namelist file.
2. You need to setup your environment for meorg_client before using this feature.
1. Use the option names and values as implemented in the cable namelist file.
2. Use the option names and values as implemented in the cable namelist file.
3. You need to setup your environment for meorg_client before using this feature.

The evaluation results will be in modelevaluation.org on the Model Output page you've specified
The evaluation results will be on modelevaluation.org accessible from the Model Output page you've specified

## Evaluation of a bug fix affecting all science options

Expand All @@ -105,7 +106,7 @@ If you have a bug fix that affects all CABLE simulations, you need to run:
- the development branch as is

```yaml
realisations: # (1)
realisations:
- repo:
git:
branch: main
Expand All @@ -114,7 +115,7 @@ realisations: # (1)
branch: XXXXX

fluxsite:
meorg_model_output_id: ZZZZ # (2)
meorg_model_output_id: ZZZZ # (1)

modules: [
intel-compiler/2021.1.1,
Expand All @@ -123,10 +124,9 @@ modules: [
]
```

1. Use the same option names and values as implemented in the cable namelist file.
2. You need to setup your environment for meorg_client before using this feature.
1. You need to setup your environment for meorg_client before using this feature.

The evaluation results will be in modelevaluation.org on the Model Output page you've specified
The evaluation results will be on modelevaluation.org accessible from the Model Output page you've specified

## Early test of development using a local repository

Expand Down Expand Up @@ -171,8 +171,8 @@ modules: [
1. Testing at one flux site only to save time and resources.
2. We are using the same branch twice so we need to name each occurrence differently.
3. Give the full path to your local CABLE repository with your code changes.
4. Use the same option names and values as implemented in the cable namelist file.
5. You need to setup your environment for meorg_client before using this feature. This option should only appear with the "my-feature-on" `repo` option.
4. Use the option names and values as implemented in the cable namelist file.
5. You need to setup your environment for meorg_client before using this feature.
6. You can reduce the requested resources to reduce the cost of the test.

Comparisons of R0 and R1 should show bitwise agreement. R2 and R0 comparison on modelevaluation.org shows the impact of the changes.
Comparisons of R0 and R1 should show bitwise agreement. R2 and R0 (and R1) comparison on modelevaluation.org shows the impact of the changes.

0 comments on commit 01dbc88

Please sign in to comment.