CMEPS icon indicating copy to clipboard operation
CMEPS copied to clipboard

documentation needs update

Open uturuncoglu opened this issue 5 years ago • 0 comments
trafficstars

My specific comments as follows,

  • Section 2.1
    • It is not clear the explanation for Sx_t. How do we know that it is sent to atmospheric component just by looking to the name of it. I know that x is export from mediator but there is no indication that it will be exported to atmosphere component. Is there any rule behind it. If so, it might be add it to the documentation.
    • the flux variables exported from mediator does not follow the rule that is used for the mediator import. Am I wrong?
  • Section 2.2.1
    • it could be nıce to add options for comp_index
  • Section 2.2.2
    • same for comp_index_src and comp_index_dst
    • it would be nice to have section related with the normalization just after mapnorm

The following are the missing points that i think,

  • it could be nice to have a section that explains the steps to bring new component to the CMEPS
    • cap specific modifications that are needed
      • adding cpl_scalars to component cap
      • run seq and minimal config definitions
      • etc.
    • when the new coupling mode is needed? Is it possible to use existing one or create a new one for each app? In my experience, the user need to create one for each application until it will be implemented in a way of data driven approach.
    • debugging could be another section. BTW, I am plaining to add Diagnostic NUOPC attribute in the next PR (if I have). It will be off by default but it could give us more tool to debug the code.
    • can we really run CMEPS just by using “CMEPS application independent attributes”? I did not test it in the HAFS app but it would be nice to test it. What about S2S application? Are we only using those small set of attributes. Of course this depends on the application and if you use data components from CDEPS you might need to define more.

uturuncoglu avatar Jul 31 '20 17:07 uturuncoglu