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.
...
| Page Properties | ||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||
|
| Expand | |||
|---|---|---|---|
| |||
|
...
The new v1 capability will read in netCDF files containing ocean surface distributions of marine macromolecules (lipids, polysaccharides, and proteins) and produce
Requirements
Requirement 1: Calculation of marine organic emissions from offline fields produced from marine biogeochemistry models
Date last modified:
Contributors: Susannah Burrows, Scott Elliott (Unlicensed), Richard Easter (Unlicensed)
Each requirement is to be listed under a ”section” heading, as there will be a one-to-one correspondence between requirements, design, proposed implementation and testing. Requirements should not discuss technical software issues, but rather focus on model capability. To the extent possible, requirements should be relatively independent of each other, thus allowing a clean design solution, implementation and testing plan.
Algorithmic Formulations
Design solution 1a: Formulation of relationship between ocean surface organic concentrations and organic mass fraction of emitted sea spray aerosol
Date last modified:Dec 2014
Contributors: Susannah Burrows, Scott Elliott (Unlicensed), Phil Rasch (pnl.gov)
See Burrows et al., 2014, ACP.
Burrows, S. M., Ogunro, O., Frossard, A. A., Russell, L. M., Rasch, P. J., and Elliott, S. M.: A physically based framework for modeling the organic fractionation of sea spray aerosol from bubble film Langmuir equilibria, Atmos. Chem. Phys., 14, 13601-13629, doi:10.5194/acp-14-13601-2014, 2014.
Design solution 1b: Formulation of assumed relationships between marine organic mass fraction and particle size and mixing state
Date last modified: Aug 2015
Contributors: Susannah Burrows
Some initial testing is documented here: /wiki/spaces/ATM/pages/32374899.
More mature testing / documentation is coming soon.
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 1a: Implementation of Burrows et al. 2014 marine organic aerosol emissions with MAM9 aerosols
Date last modified: 09/15/2015
Contributors: Susannah Burrows, Richard Easter (Unlicensed), Xiaohong Liu (add your name to this list if it does not appear)
Implementation 1b: Implementation of alternate marine organic aerosol emissions parameterizations
Date last modified: 09/15/2015
Contributors: Susannah Burrows (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?
...