search

geoschem / GCST-internal

Dummy repo for GCST project management
0 stars 0 forks source link

Add GCHP documentation for History field aliases #33

Closed lizziel closed 3 years ago

lizziel commented 3 years ago

There is the capability to assign aliases in GCHP history but we do not tap into that in GCHP. This is mainly because it might cause confusion to rename the export in the output file. However, we should include the capability in ours docs.

See also https://github.com/geoschem/geos-chem/issues/635 in which this functionality was relevant but unknown.

stale[bot] commented 3 years ago

This issue has been automatically marked as stale because it has not had recent activity. If there are no updates within 7 days it will be closed. You can add the "never stale" tag to prevent the Stale bot from closing this issue.

lizziel commented 3 years ago

@LiamBindle added documentation for configurating HISTORY.rc to GCHP ReadTheDocs. This information would be good to put there.

LiamBindle commented 3 years ago

Added the instructions for aliases to the docs for fields.

Latest docs: https://gchp.readthedocs.io/en/latest/supplement/config-files/HISTORY.html

Relevant commit: https://github.com/geoschem/GCHP/commit/4fed26163114b905aca3a09aff2dc8ea703d8449