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.
Design Document
In the table below, 4.Equ means Equations and Algorithms, 5.Ver means Verification, 6.Perf - Performance, 7. Val - Validation, 
- completed, 
- in progress, 
- not done
Overview table for the owner and an approver of this feature
1.Description | RRM |
| 2.Owner | Erika Roesler |
| 3.Created | |
| 4.Equ | |
| 5.Ver | |
| 6.Perf | |
| 7.Val | |
| 8.Approver | |
| 9.Approved Date |
Title: RRM
Requirements and Design
ACME Atmosphere Group
Date:
Summary
Requirements
Requirement: RRM CONUS case configuration
Date last modified:
Contributors: Erika Roesler Mark Taylor
Grid, initial condition, and boundary condition files were uploaded to ACME data repository. A new case was developed on a feature branch and merged to master.
Requirement: RRM CONUS case configuration
Date last modified:
Contributors: (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.
Requirement: RRM CONUS case configuration
Date last modified:
Contributors: (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:
Contributors: Erika Roesler , Mark Taylor, Steve Klein
Grid file was generated and approved by ACME Atmos group. From this grid file the initial and boundary condition files were generated. The new case was then configured.
Design and Implementation
Implementation: short-desciption-of-implementation-here
Date last modified:
Contributors: (add your name to this list if it does not appear)
This section should detail the plan for implementing the design solution for requirement XXX. In general, this section is software-centric with a focus on software implementation. Pseudo code is appropriate in this section. Links to actual source code are appropriate. Project management items, such as svn branches, timelines and staffing are also appropriate. How do we typeset pseudo code?
Planned Verification and Unit Testing
Verification and Unit Testing: Test CONUS case on other ACME-supported machines
Date last modified:
Contributors: Erika Roesler , Qi Tang, Wuyin Lin
Members of this group downloaded the feature branch and tested the case on their institutional clusters. If the case ran for the specified time, then this test and requirement was considered successful. A unit test for the RRM CONUS case in under consideration.
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?