-
Notifications
You must be signed in to change notification settings - Fork 2
/
Copy pathMPASProjectDesignTemplate.tex
82 lines (49 loc) · 3.3 KB
/
MPASProjectDesignTemplate.tex
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
\documentclass[11pt]{report}
\usepackage{epsf,amsmath,amsfonts}
\usepackage{graphicx}
\begin{document}
\title{Title: \\
Requirements and Design}
\author{MPAS Development Team}
\maketitle
\tableofcontents
%-----------------------------------------------------------------------
\chapter{Summary}
The purpose of this section is to summarize what capability is to be added to the MPAS 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.''
%figure template
%\begin{figure}
% \center{\includegraphics[width=14cm]{./Figure1.pdf}}
% \caption{A graphical representation of the discrete boundary.}
% \label{Figure1}
%\end{figure}
%-----------------------------------------------------------------------
\chapter{Requirements}
\section{Requirement: XXX}
Date last modified: 2011/01/05 \\
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 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.
%-----------------------------------------------------------------------
\chapter{Algorithmic Formulations}
\section{Design Solution: XXX}
Date last modified: 2011/01/05 \\
Contributors: (add your name to this list if it does not appear) \\
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.
%-----------------------------------------------------------------------
\chapter{Design and Implementation}
\section{Implementation: XXX}
Date last modified: 2011/01/05 \\
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?
\begin{verbatim}
verbatim?
\end{verbatim}
%-----------------------------------------------------------------------
\chapter{Testing}
\section{Testing and Validation: XXX}
Date last modified: 2011/01/05 \\
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?
%-----------------------------------------------------------------------
\end{document}