Skip to content

Commit d375dfe

Browse files
move and update run-MDTF README.md
1 parent e6ad728 commit d375dfe

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

tools/run-MDTF/doc/README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# run-MDTF
2+
Shell driver script to run the MDTF-diagnostics package with the GFDL FRE workflow <br />
3+
4+
Command-line usage:
5+
6+
```
7+
$ run-mdtf.sh -i /path/to/pp/dir/pp -o out_dir/mdtf -s startyr -e endyr
8+
```
9+
10+
Input:
11+
- A user-specified configuration file `pod_config.json` located in the **config** directory that is run
12+
by default. Users should modify this template to run their desired POD(s) and update query parameters such as *realm*
13+
A different configuration file can be supplied with the `-l` OPTARG.
14+
- `-i`: path to the input directory ending in /pp with the target dataset
15+
- `-o`: path to directory to write the output
16+
- `-s`: start year of the dataset
17+
- `-e`: end year of the dataset

0 commit comments

Comments
 (0)