The Design Document page provides a description of the algorithms, implementation and planned testing including unit, verification, validation and performance testing. Please read Step 1.3 Performance Expectations that explains feature documentation requirements from the performance group point of view.
...
Date:
Summary
The
purpose of this section is to summarize what capability is to beriverine suspended sediment capacity is added to the
ACME Ocean and Ice system through this design process. It should be clear what new code will do that the current code does not. Summarizing the primary challenges with respect to software design and implementation is also appropriate for this section. Finally, this statement should contain general statement with regard to what is “success.”Requirements
Requirement: name-of-requirement-here
Date last modified: // date
Contributors: @ name (add your name to this list if it does not appear)
Each requirement is to be listed under a ”section” heading, as there will be a one-to-one correspondence between requirements, design, proposed imple- mentation and testing. Requirements should not discuss technical software issues, but rather focus on model capability. To the extent possible, require- ments should be relatively independent of each other, thus allowing a clean design solution, implementation and testing plan.Algorithmic Formulations
Design solution: short-description-of-proposed-solution-here
Date last modified:// dateContributors: (add your name to this list if it does not appear)
E3SM BGC system. The new code simulates the suspended sediment fluxes from hillslopes into small rivers then through the river systems to the coasts. It also simulates the riverine sediment transport, erosion and deposition processes as function of hydraulic conditions simulated by MOSART-water. The success of the code would be satisfactory performance evaluated against the observed sediment discharges over multiple river gauges in different river systems.
Requirements
Requirement: Implementing riverine sediment process description on top of ELM soil erosion (Zeli Tan), MOSART-water and water management.
Date last modified: Jun 30 2019
Contributors: Hongyi Li, Zeli Tan, Tian Zhou, Ruby Leung
MOSART-sediment has been developed and tested offline in a data-land mode based on the apcraig/mosart/add-inundation branch which was based off the E3SM v1 master branch a while ago. I will create a new MOSART-sediment branch based on the merger of two new branches tizhou/mosart/add-wm-inundation and tanzeli/lnd/elm-erosion-master. The former is based off the latest E3SM v2 master branch and includes the newest code of MOSART-water and water management. The latter is also based off the latest E3SM v2 master branch and includes the newest code of soil erosion.
Requirement: Validating MOSART-sediment
Date last modified: Jun 30 2019
Contributors: Hongyi Li, Zeli Tan, Tian Zhou, Ruby Leung
MOSART-sediment simulations will be validated against the observed sediment data from multiple USGS gauges.
Algorithmic Formulations
Design solution: Riverine sediment processes
Date last modified: Jun 30 2019
Contributors: Hongyi Li, Zeli Tan, Tian Zhou, Ruby Leung
For each requirement, there is a design solution that is intended to meet that requirement. Design solutions can include detailed technical discussions of PDEs, algorithms, solvers and similar, as well as technical discussion of performance issues. In general, this section should steer away from a detailed discussion of low-level software issues such as variable declarations, interfaces and sequencing.
Design and Implementation
Implementation: short-desciption-of-implementation-here
Date last modified: // date
Contributors: (add your name to this list if it does not appear)
Planned Verification and Unit Testing
Verification and Unit Testing: short-desciption-of-testing-here
Date last modified:
Contributors: (add your name to this list if it does not appear)
How will XXX be tested? i.e. how will be we know when we have met requirement XXX. Will these unit tests be included in the ongoing going forward?
Planned Validation Testing
Validation Testing: short-desciption-of-testing-here
Date last modified:
Contributors: (add your name to this list if it does not appear)
How will XXX be tested? What observational or other dataset will be used? i.e. how will be we know when we have met requirement XXX. Will these unit tests be included in the ongoing going forward?
Planned Performance Testing
Performance Testing: short-desciption-of-testing-here
Date last modified:
Contributors: (add your name to this list if it does not appear)
How will XXX be tested? i.e. how will be we know when we have met requirement XXX. Will these unit tests be included in the ongoing going forward?
...