W11 Design Document for Atmospheric Chemistry and Radiation

Owned by
Renata McCoy
Last updated: Jul 16, 2019 by
Robert Jacob
1 min read

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

 Click here for instructions to fill up the table below ......

The first table in Design Document gives overview of this document, from this info the Design Documents Overview page is automatically created.

In the overview table below 4.Equ means Equations and Algorithms, 5.Ver means Verification, 6.Perf - Performance, 7. Val - Validation

  • Equations: Document the equations that are being solved and describe algorithms
  • Verification Plans: Define tests that will be run to show that implementation is correct and robust. Involve unit tests to cover range of inputs as well as benchmarks.
  • Performance expectations: Explain the expected performance impact from this development
  • Validation Plans: Document what process-based, stand-alone component, and coupled model runs will be performed, and with what metrics will be used to assess validity

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,   (tick) - competed, (warning) - in progress, (error) - not done


Overview table for the owner and an approver of this feature

1.Description


2.Owner


3.Created
4.Equ
5.Ver
6.Perf
7.Val
8.Approver
 
9.Approved Date
 Click here for Table of Contents ...

Table of Contents




Title: NA1: Atmospheric Chemistry and Radiation

Requirements and Design

NGD Atmosphere

Date:    

Summary

This design document covers  ...

Requirements

Requirement: ............

Date last modified: 
Contributors: 

.....description.....

.....reference.....


Requirement: ........

Date last modified: 
Contributors: 

.....description.....

.....reference......

Algorithmic Formulations, and Design Implementation


Design Solution: ......

Date last modified: 
Contributors: 

.....description.....

.....reference.....


Design Solution: ......

Date last modified: 
Contributors: 

.....description.....

.....reference.....

 

Planned Verification and Unit Testing 

Verification and Unit Testing: .......

Date last modified: 
Contributors: 

.....description.....

.....reference.....


Planned Validation Testing 

Validation Testing:  ........

Date last modified: 
Contributors: 

.....description.....

.....reference.....

Planned Performance Testing 

Performance Testing: .........

Date last modified: 
Contributors: 

.....description.....

.....reference.....