Add User's Guide template for test groups

E3SM-Project / polaris

Testing and analysis for OMEGA, MPAS-Ocean, MALI and MPAS-Seaice

BSD 3-Clause "New" or "Revised" License

6 stars 13 forks source link

Add User's Guide template for test groups #41

Closed cbegeman closed 1 year ago

cbegeman commented 1 year ago

This PR adds a template for test groups for the User's Guide to help ensure all the details relevant to the configuration of a test case in a test group are provided.

Checklist

[X] User's Guide has been updated
[X] Documentation has been built locally and changes look as expected

cbegeman commented 1 year ago

@xylar Let me know what you think. One we're happy with the template, I will update the baroclinic_channel user's guide in addition to global_convergence. Also, if you would like the template to live one directory up so that it isn't specific to the ocean component, we could do that.

cbegeman commented 1 year ago

@alicebarthel I made the two changes we discussed in our meeting. Would you like to give this a look before we merge?

cbegeman commented 1 year ago

@xylar I updated the baroclinic_channel user's guide as well. You might want to take a look given that it is the target of the tutorial.

cbegeman commented 1 year ago

Thanks for reviewing @xylar and @alicebarthel!