Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Test case summary docs #242

Open
wants to merge 8 commits into
base: master
Choose a base branch
from
Open

Test case summary docs #242

wants to merge 8 commits into from

Conversation

daw538
Copy link
Contributor

@daw538 daw538 commented Nov 10, 2022

Rewrite and update of the current REAMDE.md file located in the exp/test_cases directory. Have updated to include the APE and SOCRATES test cases along with relevant references.

@daw538 daw538 added the docs label Nov 10, 2022
@daw538
Copy link
Contributor Author

daw538 commented Mar 5, 2023

I've now updated this to include changes associated with the cloud scheme in #246

@daw538 daw538 requested review from penmaher and sit23 March 17, 2023 15:13
Copy link
Contributor

@penmaher penmaher left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Docs look good. A few minor suggestions.

@@ -1,6 +1,6 @@
# Project-specific
compilation*/
docs/source/examples/index.rst
# docs/source/examples/index.rst
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we hash it or just remove it from the list?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks helpful, not sure why it was not included in the master

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

After the gv3 disc failure I don't have an environment to set up the infrastructure to set this up in a way that displays this in the browser. I am giving you the benefit of the doubt that it looks good :-)

@@ -0,0 +1,65 @@
Cloud Scheme (SimCloud)
=======================

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Given the code uses other peoples code (i.e. CAM and Romps, was there anyone else?) I think we should credit that code in here somewhere.


The cloud scheme may be found in the directory ``src/atmos_param/cloud_simple``, with tuneable parameters found therein.

A demonstration test case is provided within Isca's test suite of experiments. The scheme is provided on an as-in basis: parameters have been tuned for an Earth-like demonstration so any deviations from such a setup or modifications to the parameterisation are at your own risk. The model should be used with the SOCRATES radiation scheme.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you provide the path and name please?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can I also suggest that you comment that there are 2 cloud schemes in the model and that this is the one we recommend people use?


Authors
-------
This documentation was written by Daniel Williams (with thanks to Qun Liu for implementing the model).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

update to:
"This documentation was written by Daniel Williams and reviewed by Penelope Maher and X." Is Neil listed to review too?
I then suggest you add:

"The SimCloud scheme was implemented by Qun Liu who greatly improved the cloud scheme implemented by Penelope Maher and Stephen Thomson."

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants