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

Update README.md, remove README_TODO.txt #425

Merged
merged 8 commits into from
Jan 7, 2022
Next Next commit
Easy stuff first: correct spelling, remove note about this being a un…
…-supported pre-release
mkavulich committed Jan 6, 2022
commit f44ebc1c15432fc9286e07226d4e312e5905562d
16 changes: 1 addition & 15 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# CCPP Framwork
# CCPP Framework

Common Community Physics Package (CCPP) Framework.

@@ -16,20 +16,6 @@ testing of the CCPP. The CCPP repository may also be used in conjunction with th
GMTB Single Column Model (SCM). Please see the [GMTB SCM+CCPP page](http://www.dtcenter.org/GMTB/gmtb_scm_ccpp_doc/)
for more information on combining the GMTB SCM and the CCPP.

This is the release v0.1.0 of the CCPP. As this is the initial release,
the CCPP only has infrastructure to support the neccesary functioning of
the anticipated package, without having actual (i.e. physically valid)
physical parameterization schemes included. The included physical
parameterization schemes inside of the CCPP are "stub" only. While the
schemes do have arguments similar to what traditional schemes require
(wind, surface temperature, physical constants), the schemes immediately
return after a message "I am in this scheme" has been output.

This repository for the CCPP and the CCPP driver contains tests to verify
proper running of the CCPP and driver. Detailed information on how to
include fully functioning physical parameterizations schemes will be
provided once examples of fully functioning schemes are part of the CCPP.

## Requirements

### Compilers