Preparations for first lecture - outline, first lectures slides, initial classlist

CourseOutline/CAS741_Outline.tex

@@ -45,14 +45,15 @@ Dr.~Spencer Smith\\
 Office: ITB/167\\
 E-mail: \texttt{smiths@mcmaster.ca}\\
 Web: \url{http://www.cas.mcmaster.ca/~smiths}\\
-Office Hours Term 1: Drop in, or by appointment\\
+Office Hours: Drop in, or by appointment\\
 
 \section{Calendar Description} 
 
 This course presents the basic principles of software development for reliable
-scientific and engineering software.  Using example applications, a systematic
-process is given for the development and documentation of requirements, system
-design, module design, implementation, testing and inspection.
+and sustainable scientific and engineering software.  Using example
+applications, a systematic process is given for the development and
+documentation of requirements, system design, module design, implementation,
+testing and inspection.
 
 \section{Introduction}
 
@@ -153,8 +154,8 @@ waterfall model, with the following milestones:
 \item Module Guide (MG)
 \item Module Interface Specification (MIS)
 \item Implementation (any appropriate programming language)
-\item Verification and Validation (VnV) Plan (divided between several documents)
-\item Verification and Validation (VnV) Report (divided between several documents) 
+\item Verification and Validation (VnV) Plan (divided between system and unit documents)
+\item Verification and Validation (VnV) Report (divided between system and unit documents) 
 
 \end {enumerate}
 
@@ -170,44 +171,54 @@ Each student will be expected to do an informal presentation on some subset of t
 MIS, Implementation, VnV Plan and VnV Report.  It is expected the class discussion will
 assist in improving the quality of the written deliverables.  Each student will
 be expected to hand in the following written documents: SRS, MG, MIS, VnV Plan,
-VnV Report and Final Documentation.
+VnV Report, code and Final Documentation.
 
 \section {Grading}
 
 \begin {enumerate}
 
-\item Presentations and class discussion 10\%
+\item Presentations and class discussion 5\%
 
-\item ``Domain Expert'' and secondary reviewer roles 5\%
+\item ``Domain Expert'' and secondary reviewer roles 10\%
 
 \item Problem Statement 0\%
 
-\item System Requirements Specification (SRS) 20\%
+\item System Requirements Specification (SRS) 15\%
 
-\item System Verification and Validation (VnV) Plan 15\%
-\begin{enumerate}
-\item System VnV Plan
-\item Unit VnV Plan
-\end{enumerate}
+\item System Verification and Validation (VnV-Syst) Plan 15\%
 
-\item MG and Module Interface Specification (MIS) 20\%
+\item Module Guide and Module Interface Specification (MG and MIS) 15\%
 
-\item Final Documentation 30\%
+\item Final Documentation 40\%
 \begin{enumerate}
 \item Problem Statement (Revised)
 \item SRS (Revised)
 \item System VnV Plan (Revised)
 \item MG (Revised)
 \item MIS (Revised)
-\item Unit VnV Plan (Revised)
+\item Unit VnV Plan
 \item Code
 \item System VnV Report
 \item Unit VnV Report
+\item Reflection Report
 \end{enumerate}
 
+\item Drasil simple physics example, pull request accepted 5\% (Bonus)
+
 \end {enumerate}
 
-explain domain expert and secondary reviewer roles.
+Each student will be assigned as a ``Domain Expert'' (DE) for one of their
+classmates.  The DE will review (via GitHub issues) their assigned project.  In
+addition, they will write the code for one of the modules of their assigned
+project and issue a pull request through GitHub.  For the secondary reviewer
+role, the instructor will assign various review tasks throughout the term.  The
+secondary reviewers feedback will focus more on the structure and format of the
+documentation, rather than on issues related to domain knowledge.
+
+The potential bonus marks involve creating a simple physics example in Drasil
+(\url{https://github.com/JacquesCarette/Drasil}).  Drasil represents recent
+(still incomplete) work to automate many of the tasks that are currently done
+manually for design and documenting SC software.
 
 \section {Policy Statements}
 

Lectures/L01_IntroToCourse/IntroToCourse.tex

@@ -62,14 +62,10 @@
 
 \begin{itemize}
 
-\item New Graduate Student Orientation: Monday, September 9, 10 am to 1 pm %may
+\item New Grad Stdnt Orientation: Mon, Sept 9, 10 am -- 1 pm %may
                                 %cancel our class
-\item Lecture times (ITB/222)
-\begin{itemize}
-\item Wednesdays, 10:30 am to 12:00 noon
-\item Fridays, , 10:30 am to 12:00 noon
-\end{itemize}
-\item This course uses Avenue
+\item Lectures: Mon and Thurs, 10:30 am -- 12:00 noon
+\item Avenue for grade tracking
 \begin{itemize}
 \item \url{http://avenue.mcmaster.ca/} 
 \item Consider putting a picture up on Avenue
@@ -77,7 +73,7 @@
 \item We'll also use git on GitLab for the course material
 \begin{itemize}
 \item \url{https://gitlab.cas.mcmaster.ca/}
-\item Create your account by logging in
+\item Create your account by logging in, option to set CAS password to MacID password
 \item Course material and issue tracking at \url{https://gitlab.cas.mcmaster.ca/smiths/cas741}
 \end{itemize}
 \item Your projects will be hosted on GitHub
@@ -128,7 +124,8 @@
 \item Displacement of a structure
 \item Thickness of cast film
 \item Temperature of water in a solar water heating tank over time
-\item etc.
+\item Ordinary Differential Equation solver
+\item Root finding solver etc.
 \ei
 \item Includes analysis, design and ``exploration'' % point made by Isobel and Alex P
 \end{itemize}
@@ -141,7 +138,8 @@
 \frametitle{Software Engineering (SE)}
 
 \begin{itemize}
-\item An area of engineering that deals with the development of software systems that
+\item SE is an area of engineering that deals with the development of software
+  systems that
 \begin{itemize}
 \item Are large or complex
 \item Exist in multiple versions
@@ -149,11 +147,12 @@
 \item Are continuously being modified
 \item Are built by teams
 \end{itemize}
-\item Software engineering is ``application of a systematic, disciplined, quantifiable approach to the development,
-operation and maintenance of software'' (IEEE 1990)
-\item D.\ Parnas (1978) defines software engineering as ``multi-person construction of multi-version software''
-\item Like other areas of engineering, software engineering relies heavily on mathematical techniques, especially
-logic and discrete mathematics
+\item SE is ``application of a systematic, disciplined, quantifiable approach to
+  the development, operation and maintenance of software'' (IEEE 1990)
+\item D.\ Parnas (1978) defines SE as ``multi-person
+  construction of multi-version software''
+\item Like other areas of engineering, SE relies heavily on
+  mathematical techniques (logic and discrete math)
 \item SE might be applied to SC for software certification
 \end{itemize}
 
@@ -222,11 +221,12 @@ logic and discrete mathematics
  
    \item P.Eng.~(Licensed Professional Engineer in Ontario).
  
-   \item \structure{Teaching}: Software design, scientific computing, introduction to computing, 
-     communication skills, software project management.
+   \item \structure{Teaching}: Software design, scientific computing,
+     introduction to computing, communication skills, software project
+     management.
  
-   \item \structure{Research}: Application of software engineering methodologies to improve the quality of
-     scientific computing software.
+   \item \structure{Research}: Application of software engineering methodologies
+     to improve the quality of scientific computing software.
  
  \end{itemize}
 
@@ -268,7 +268,8 @@ logic and discrete mathematics
 \begin{itemize}
 \item Calendar description
 \begin{itemize}
-\item Principles of software development for reliable scientific and engineering software
+\item Principles of software development for reliable and sustainable scientific
+  and engineering software
 \item Systematic process for development and documentation of
 \bi
 \item Requirements
@@ -277,6 +278,7 @@ logic and discrete mathematics
 \item Implementation
 \item Verification and Validation Plan
 \item Verification and Validation Report
+\item Code
 \ei
 \end{itemize}
 \end{itemize}
@@ -313,6 +315,22 @@ logic and discrete mathematics
 
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
+\begin{frame}
+\frametitle{Project Selection: Desired Qualities}
+\begin{itemize}
+\item Related to scientific computing
+\item Simple, but not trivial
+\item If feasible, select a project related to your research
+\item Possibly re-implement existing software
+\item Each student project needs to be unique
+\item Possibly a specific physical problem
+\item Possibly a (family of) general purpose tool(s)
+\item Some examples follow, the links are just places to get started
+\end{itemize}
+\end{frame}
+
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
 \begin{frame}
 
 \frametitle{``Faked'' Rational Design Process}
@@ -377,26 +395,23 @@ Not all docs necessary
 
 \begin {enumerate}
 
-\item Presentations and class discussion 10\%
+\item Presentations and class discussion 5\%
 
-\item Quality of GitHub issues provided to classmates 5\%
+\item ``Domain Expert'' and secondary reviewer roles 10\%
 
 \item Problem Statement 0\%
 
-\item System Requirements Specification (SRS) 20\%
+\item System Requirements Specification (SRS) 15\%
 
-\item Verification and Validation Plan 15\%
-\begin{itemize}
-\item System VnV Plan 10\%
-\item Unit VnV Plan 5\%
-\end{itemize}
+\item System Verification and Validation (VnV-Syst) Plan 15\%
 
-\item Module Guide (MG) 5\%
-
-\item Module Interface Specification (MIS) 15\%
+\item Module Guide and Module Interface Specification (MG and MIS) 15\%
 
 \item Final Documentation (including revised versions of previous documents,
-  plus the source code and a testing reports (System and Unit)) 30\%
+  plus the source code, unit testing plan, reflection report and testing
+  reports (System and Unit)) 40\%
+
+\item Drasil simple physics example, pull request accepted 5\% (Bonus)
 
 \end {enumerate}
 
@@ -446,6 +461,9 @@ the transcript, and/or suspension or expulsion from the university.
 \begin{frame}
 \frametitle{Assigned Reading}
 
+As often as possible, hyperlinks are included for references in the lecture
+slides
+
 \begin {itemize}
 
 \item
@@ -469,6 +487,21 @@ the transcript, and/or suspension or expulsion from the university.
   \href{https://gitlab.cas.mcmaster.ca/smiths/cas741/blob/master/ReferenceMaterial/ParnasAndClements1986.pdf}
   {\bibentry{ParnasAndClements1986}}
 \item \href{https://github.com/smiths/swhs}{Solar Water Heating System Example}
+\item
+  \href{https://jacquescarette.github.io/Drasil/examples/SWHS/srs/SWHS_SRS.html}
+  {Solar Water Heating System Example SRS (Generated by Drasil)}
+\item
+  \href{https://jacquescarette.github.io/Drasil/examples/Projectile/srs/Projectile_SRS.html}
+  {Projectile Example SRS (Generated by Drasil)}
+\item Recommended reading order for SRS documents
+\begin{itemize}
+\item Goal Statement
+\item Instance Models
+\item Requirements
+\item Introduction
+\item Specific System Description
+\end{itemize}
+
 \end{itemize}
 
 \end{frame}

Lectures/L02_GettingStarted/GettingStarted.tex

@@ -227,7 +227,7 @@ Unit VnV or Implement Present & Week 12 & Week of Nov 26\\
 \item Related to scientific computing
 \item Simple, but not trivial
 \item If feasible, select a project related to your research
-\item Ideally, re-implement existing software
+\item Possibly re-implement existing software
 \item Each student project needs to be unique
 \item Possibly a specific physical problem
 \item Possibly a (family of) general purpose tool(s)

Lectures/titlepage.tex

@@ -5,7 +5,7 @@
 \newcommand{\season}{Fall} %use to switch between Winter and Fall
 \newcommand{\instructor}{Dr.~Spencer Smith} %use to switch instructor
 \newcommand{\instructSmall}{Dr.~Smith}
-\newcommand{\yr}{2018}
+\newcommand{\yr}{2019}
 \newcommand{\courseCode}{CAS 741, CES 741}
 \newcommand{\courseTitle}{Development of Scientific Computing Software}