Skip to content

Commit

Permalink
Description of config-file naming is rendered more precisely
Browse files Browse the repository at this point in the history
  • Loading branch information
h-dh committed Sep 21, 2015
1 parent 4a40336 commit d32bba5
Showing 1 changed file with 10 additions and 6 deletions.
16 changes: 10 additions & 6 deletions README.paths
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,8 @@ Check results are usually written to a path provided by
option QC_RESULTS in a config file (or on the command-line).
The default path is identical to the work-space.

The path to a work-space is provided by option '--workspace=str'.
The path to a work-space is provided by option '--workspace=str'
and the addition of -e_qa_work=path, respectively.
The workspace contains updated and/or user-modified tables,
a CF test suite (after the first run of dkrz-cf-checker),
and results of an example run (which is executed
Expand All @@ -14,12 +15,15 @@ The default for a work-space depends on how QA-DKRZ was fetched:
conda: $HOME/.qa-dkrz by default.
GitHub: path to the QA_DKRZ package

$HOME/.qa-dkrz is the home of a 'config' file used to store paths etc. .
$HOME/.qa-dkrz is the home of a configuration file used to store paths etc. .
If this doesn't exist, then a file '.conf' is written to QA-DKRZ, i.e
the package downloaded by 'conda' or from GitHub. If additionally
QA-DKRZ is without write-permissions, then the user is asked to
use --workspace. This unlikely case requires --workspace to be provided
for each run of the script 'QA-DKRZ/scripts/qa-dkrz'.
the package downloaded by 'conda' or from GitHub. The name of the configuration
file depends on the method QA-DKRZ was fetched.
GitHub: config.src
conda: config.conda
In case that QA-DKRZ is without write-permissions, then the user is asked to
provide a workspace; this unlikely case requires option --workspace to be
applied each time the script 'QA-DKRZ/scripts/qa-dkrz' is run.

Please, note for multi-user purpose that $HOME of each users has to exist.

0 comments on commit d32bba5

Please sign in to comment.