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
Expand | ||
---|---|---|
| ||
The first table in Design Document gives overview of this document, from this info the Design Documents Overview page is automatically created. In the table below, 4.Equ means Equations and Algorithms, 5.Ver means Verification, 6.Perf - Performance, 7. Val - Validation
Use the symbols below (copy and paste) to indicate if the section is in progress or done or not started. |
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
HTML Comment |
---|
- competedcompleted, - in progress, - not done |
Page Properties | ||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||
|
Expand | |||
---|---|---|---|
| |||
|
Title:
...
Polar Mods to aerosol, convective transport and clouds
Requirements and Design
ACME
...
Atmosphere Group
Date:
Summary
Requirements
Requirement: name-of-requirement-here
Date last modified:
Contributors: (add your name to this list if it does not appear)
task is to port a number of model developments, aimed at improving the representations of clouds and aerosols, from an earlier version of CAM5 to the ACME model. The modifications were done under the DOE-ESM Polar project, which have been shown to improve global aerosol distribution, aerosol deposition to snow, and cloud water at high latitudes in CAM5 (Wang et al., 2013; Qian et al., 2014; Liu et al., 2015).
Requirements
- changes to the convective transport of aerosol/gas, wet scavenging/removal, resuspension, etc.
- add a new aerosol module to account for the aging process of carbonaceous aerosols.
- add a new ice nucleation scheme that connects to aerosols
Date last modified:
Contributors: Hailong Wang, Richard Easter (Unlicensed), Xiaohong Liu
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
- see Wang et al. (2013)
- see Liu et al. (2015, GMDD)
Date last modified:
Contributors: Hailong Wang,
(add your name to this list if it does not appear)Richard Easter (Unlicensed), Xiaohong Liu
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- following Wang et al. (2013)
- following Liu et al. (2015)
Date last modified:
Contributors: Hailong Wang, Balwinder Singh,
(add your name to this list if it does not appearRichard Easter (Unlicensed)
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: short-desciption-of-testing-here- will verify results against those shown by Wang et al. (2013) and Qian et al. (2014)
- will verify results against those shown by Liu et al. (2015)
Date last modified:
Contributors:
(add your name to this list if it does not appear)Hailong Wang, Balwinder Singh, Po-Lun Ma
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- following Wang et al. (2013) and Qian et al. (2014) to validate results using various observational datasets
- following Liu et al. (2015) to validate results using various observational datasets
- make plots avaiiable to the atmosphere team using the aerosol diagnostics package
Validation Testing: Hailong Wang, Balwinder Singh, Po-Lun Ma
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?
...