Skip to content

Commit 03d7c86

Browse files
committed
improve readme
1 parent c13564c commit 03d7c86

File tree

1 file changed

+28
-8
lines changed

1 file changed

+28
-8
lines changed

README.md

Lines changed: 28 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -80,6 +80,32 @@ Visualize the performance database generated with `performance`.
8080

8181
Even though probtest is used exclusively with ICON at the moment, it does not contain any information about the model or its directory structure. This makes it very flexible and applicable to any circumstance (e.g. usable by Buildbot, Jenkins and human users alike). However, it also requires a lot of information about the model and the data to be processed upon invocation. Since a typical probtest usage involves multiple commands (e.g. run-ensemble -> stats -> tolerance -> check) this leads to a lot of redundancy in the invocation. Therefore, probtest can read commonly used input variables (e.g. the model output directory, the experiment name, the name of the submit script, ...) from a configuration file in json format. To further ease the process, these configuration files can be created from templates using the `init` command. A template for ICON is contained in this repository in the `templates` subdirectory.
8282

83+
### Setup conda
84+
85+
All requirements for using probtest can be easily installed with conda using the
86+
setup scripts.
87+
88+
For setting up conda you use
89+
```console
90+
./setup_miniconda.sh -u
91+
```
92+
which will modify your `.bashrc`, or you can use
93+
```console
94+
./setup_miniconda.sh
95+
source miniconda/bin/activate
96+
```
97+
which requires the source minconda.
98+
99+
The pinned requiremnts can be installed by
100+
```console
101+
./setup_env.sh
102+
```
103+
The unpinned requirements and updating the environment can be done by
104+
```console
105+
./setup_env.sh -u -e
106+
```
107+
108+
83109
### The init command
84110

85111
This command sets up the configuration file. For more help on the command line arguments for `init`, see
@@ -102,14 +128,8 @@ Objective: Run an `exp_name` ICON experiment with an test build and check if the
102128
output of the test is within a perturbed ensemble of the reference build.
103129
This is in particular used to validate a GPU build against a CPU reference.
104130

105-
All requirements for using probtest can be easily installed with conda using the
106-
setup scripts:
107-
108-
```console
109-
./setup_miniconda.sh
110-
source miniconda/bin/activate
111-
./setup_env.sh
112-
```
131+
You need to have setup a proper environment, for example as described in the
132+
section [Setup conda](#setup-conda).
113133

114134
#### Initialize probtest
115135
Once set up, probtest can generate the config file according to your needs.

0 commit comments

Comments
 (0)