Skip to content

Commit

Permalink
Update README.md (#239)
Browse files Browse the repository at this point in the history
* Update README.md

* Update workflow.md
  • Loading branch information
chengzhuzhang authored Feb 5, 2024
1 parent c222f9f commit 911f26d
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 3 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,10 +46,10 @@ python -m pip install .

## Example

Here's an example of the tool usage, with the variables tas, prc, and rlut. The time-series files containing the regridded output are in a directory named input_path, and a directory named output_path will be used to hold the CMIP6 output.
Here's an example of the tool usage, with the variables tas, prc, and rlut. The time-series files containing the regridded output are in a directory named input_path, and a directory named output_path will be used to hold the CMIP6 output. A copy of an example metadata definition file (default_metadata.json) can be found [here](https://github.com/E3SM-Project/e3sm_to_cmip/blob/master/e3sm_to_cmip/resources/default_metadata.json).

```
e3sm_to_cmip -v tas, prc, rlut --realm atm --input ./input_path/ --output ./output_path/ -t ~/cmip6-cmor-tables -u e3sm_user_config_picontrol.json
e3sm_to_cmip -v tas, prc, rlut --realm atm --input ./input_path/ --output ./output_path/ -t ~/cmip6-cmor-tables -u default_metadata.json
```

This will produce a directory tree named CMIP6 below the output_path, with the CMIP6 directory tree based on the metadata json file.
2 changes: 1 addition & 1 deletion docs/guides/workflow.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Note that although the e3sm_to_cmip package itself can be installed via conda, t

Processing data with CMOR requires a metadata json file containing all the information about the case being processed. Additionally your activities, sources, and institution must be registered with the CMIP6 project. For more information see the CMOR documentation here: https://cmor.llnl.gov/mydoc_cmor3_CV/

A working example of the case metadata file is contained as part of the e3sm_to_cmip repo, and can be accessed here: https://raw.githubusercontent.com/E3SM-Project/e3sm_to_cmip/master/e3sm_user_config_picontrol.json
A working example of the case metadata file (default_metadata.json) is contained as part of the e3sm_to_cmip repo, and can be accessed [here](https://github.com/E3SM-Project/e3sm_to_cmip/blob/master/e3sm_to_cmip/resources/default_metadata.json).


## CWL workflows
Expand Down

0 comments on commit 911f26d

Please sign in to comment.