Changes related to updating the MIS presentation and checklist

BlankProjectTemplate/docs/Design/MIS/MIS-Checklist.tex

@@ -99,8 +99,10 @@
   \item State invariant is initially satisfied
   \item Local functions make the specification easier to read (there is no
     requirement that the local functions will actually be implemented in code)
-    \item Modules that deal with files, the keyboard, or the screen, have
-      environment variables to represent these respective entitites
+  \item Modules that deal with files, the keyboard, or the screen, have
+    environment variables to represent these respective entitites
+  \item Symbols are from SRS - not yet translated to code names (that is use
+    $\theta$, not \texttt{theta})
   \end{todolist}
 
 \item MIS Quality inspection for each module

Lectures/L15_MIS/MIS.tex

@@ -31,7 +31,7 @@
 
 \input{../def-beamer}
 
-\newcommand{\topic}{14 Module Interface Specification (MIS)}
+\newcommand{\topic}{Module Interface Specification (MIS)}
 
 \input{../titlepage}
 
@@ -48,15 +48,10 @@
 \item Start recording
 \item Administrative details
 \item Questions?
-\item Finish previous day slides
+%\item Finish previous day slides
 \item Module guide example
+\item MIS example
 \item Integration testing
-\item Mathematical review (\cite{HoffmanAndStrooper1995} and separate slides)
-\begin{itemize}
-\item Multiple assignment statement
-\item Conditional rules
-\item etc.
-\end{itemize}
 \item MIS overview
 \item Modules with external interaction
 \item Abstract objects
@@ -68,21 +63,43 @@
 
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
+\begin{frame}
+\frametitle{Administrative Details}
+
+\bi
+\item When developing your code, remember that your goal is for someone else to
+  be able to compile and run it
+\item Upcoming classes
+\bi
+\item L15 - Module Interface Specification
+\item L16 - Math Review + MIS
+\item L17 - POC + MG Presentations
+\item L18 - MIS Presentations
+\ei
+\item Mathematical review (\cite{HoffmanAndStrooper1995} and separate slides)
+\ei
+
+\end{frame}
+
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
 \begin{frame}
 \frametitle{Administrative Details: Report Deadlines}
 ~\newline
-\begin{tabular}{l l l}
-System VnV Plan & Week 08 & Oct 28\\
-MG + MIS & Week 10 & Nov 25\\
-Final Documentation & Week 14 & Dec 9\\
+\begin{tabular}{l l}
+%\textbf{SRS} & Oct 8\\
+\textbf{MG + MIS (Traditional)} & Nov 19\\
+\textbf{Drasil Code and Report (Drasil)} & Nov 19\\
+Final Documentation & Dec 9\\
 \end {tabular}
 
 \bi
 \item The written deliverables will be graded based on the repo contents as of
 11:59 pm of the due date
-\item If you need an extension, please ask
+\item If you need an extension for a written deliverable, please ask
+\item You should inform your primary and secondary reviewers of the extension
 \item Two days after each major deliverable, your GitHub issues will be due
-\item Domain expert code due 1 week after MIS deadline
+%\item Domain expert code due 1 week after MIS deadline
 \ei
 
 \end{frame}
@@ -90,20 +107,25 @@ Final Documentation & Week 14 & Dec 9\\
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
 \begin{frame}
-\frametitle{Administrative Details: Presentations}
-
-~\newline
-\begin{tabular}{l l l}
-MG + MIS Syntax Present & Week 9 & Week of Nov 4\\
-MIS Semantics Present & Week 11 & Week of Nov 18\\
-Unit VnV or Impl.\ Present & Week 12/13 & Week of Nov 28\\
-\end {tabular}
+\frametitle{Admin Details: Presentation Schedule}
 
 \bi
-\item Informal presentations with the goal of improving everyone's written
-  deliverables
-\item Domain experts and secondary reviewers (and others) will ask questions
-  (listed in Repos.xlsx file)
+\item Proof of Concept Demonstrations (15 min)
+\bi
+\item \textbf{Thurs, Nov 12: Salah, John}
+\ei
+\item MG Present (10 minutes)
+\bi
+\item \textbf{Thurs, Nov 12: John, Tiago, Leila, Xuanming, Andrea}
+\ei
+\item MIS Present
+\bi
+\item Mon, Nov 16: Shayan, Parsa, Gaby, Sid, Xingzhi
+\ei
+\item Drasil Project Present (20 min each)
+\bi
+\item Thurs, Nov 26: Andrea, Naveen, Ting-Yu
+\ei
 \ei
 
 \end{frame}
@@ -111,29 +133,50 @@ Unit VnV or Impl.\ Present & Week 12/13 & Week of Nov 28\\
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
 \begin{frame}
-\frametitle{Administrative Details: Presentation Schedule}
+\frametitle{Presentation Schedule Continued}
 
 \bi
-\item MG + MIS Syntax Present
+\item Test or Impl.\ Present (15 min each)
 \bi
-\item Monday:  \textbf{Deema, Bo, ?}
-\item Thursday: \textbf{Sasha, ?, ?}
+\item Mon, Nov 30: John, Salah, Liz, Xingzhi, Leila
+\item Thurs, Dec 3: Shayan, Naveen, Sid, Gaby, Seyed
+\item Mon, Dec 7: Ting-Yu, Xuanming, Mohamed, Andrea, Tiago
 \ei
-\item MIS Syntax + Semantics Present
+\item 4 presentations each
+\item If you will miss a presentation, please trade with someone else
+\ei
+
+\end{frame}
+
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
+\begin{frame}
+\frametitle{MG and MIS Presentations}
+\begin{itemize}
+\item MG Presentation
 \bi
-\item Monday: Zhi, Peter, \emph{Sasha}
-\item Thursday:  Sharon, Ao, ?
+\item Likely Changes
+\item Decomposition Hierarchy Figure
+\item Uses Relation Hierarchy
+\item Secrets of Most Important Modules
 \ei
-\item Unit VnV Plan or Impl.\ Present
+\item MIS Presentations
+\bi
+\item Uses Relation Hierarchy
+\item Syntax
 \bi
-\item Monday: Bo, Sasha, ?
-\item Thursday: Zhi, Peter, Ao, ?
+\item Access Programs (types of inptus and outputs)
+\item State Variables
+\item Environment Variables
+\item Type of module (record, library, abstract object, ADT, generic)
 \ei
+\item Semantics - don't get caught up with them at this point
+\bi
+\item What modules cause state or environment transitions?
+\item Can you describe access program behaviour in words?
 \ei
-
-Optional presentation in italics.\\
-Room for more volunteers.  :-)
-
+\ei
+\end{itemize}
 \end{frame}
 
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
@@ -141,7 +184,11 @@ Room for more volunteers.  :-)
 \begin{frame}
 \frametitle{Questions?}
 \begin{itemize}
-\item Questions about Module Guide and the presentation?
+\item Questions on administrative details?
+\item Questions about Module Guide?
+\item Questions about upcoming presentation?
+\item Questions about design?
+\item Questions about anything (course related)?
 \end{itemize}
 \end{frame}
 
@@ -160,29 +207,6 @@ Room for more volunteers.  :-)
 
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
-\begin{frame}
-\frametitle{MG + MIS Syntax Presentations}
-\begin{itemize}
-\item MG
-\begin{itemize}
-\item Decomposition by secrets
-\item Interesting module secrets
-\item Uses relationship
-\end{itemize}
-\item MIS Syntax
-\begin{itemize}
-\item Access routine syntax (types of inputs and outputs)
-\item State variables
-\item Environment variables (necessary for modules with files/screens/keyboards)
-\item Type of module (record, ``library'', abstract object, ADT, generic)
-\end{itemize}
-\item Discuss MG secret together with MIS syntax
-\item Not necessary to cover all details
-\end{itemize}
-\end{frame}
-
-%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-
 \begin{frame}
 \frametitle{Solar Water Heating System Example}
 
@@ -538,6 +562,23 @@ are isolated to their own access programs (like submodules). %    This, combined
 
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
+\begin{frame}
+\frametitle{MIS Example: SWHS}
+
+\bi
+\item \href{https://github.com/smiths/swhs}{https://github.com/smiths/swhs}
+\item Has some constant values
+\item Input parameters
+\item Solve ODEs for temperature of water and PCM
+\item Solve for energy in water and PCM
+\item Output results
+\item Generate plots
+\ei
+
+\end{frame}
+
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
 \begin{frame}
 \frametitle{MIS Template}
 
@@ -797,27 +838,56 @@ seq\_init():
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
 \begin{frame}
-\frametitle{Examples of Modules \cite{GhezziEtAl2003}}
-
-\begin{itemize}
+\frametitle{Examples of Modules: Record \cite{GhezziEtAl2003}}
 
-\item \structure{Record}
 \begin{itemize}
 \item Consists of only data
 \item Has state but no behaviour
+\item Example
+\bi
+\item Specification Parameters Module in SWHS
+\ei
 \end{itemize}
-\item \structure{Collection of related procedures (library)}
+
+\end{frame}
+
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
+\begin{frame}
+\frametitle{Examples of Modules: Library \cite{GhezziEtAl2003}}
+
 \begin{itemize}
+\item \structure{Collection of related procedures (library)}
 \item Has behaviour but no state
 \item Procedural abstractions
 % like many routines in a scientific computing library
+\item Example
+\bi
+\item Library of trigonometric functions
+\item ODE Solver Module in SWHS
+\item
+  \href{https://gitlab.cas.mcmaster.ca/smiths/se2aa4_cs2me3/-/blob/master/Assignments/PreviousYears/2018/A2/A2.pdf}
+  {Sequence Services Module}
+\ei
 \end{itemize}
-\item \structure{Abstract object}
+
+\end{frame}
+
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
+\begin{frame}
+\frametitle{Examples of Modules: Abstract Object  \cite{GhezziEtAl2003}}
+
 \begin{itemize}
 \item Consists of data (\structure{fields}) and procedures (\structure{methods})
 \item Consists of a collection of \structure{constructors},
   \structure{selectors}, and \structure{mutators}
 \item Has state and behaviour
+\item There is only ONE
+\item Example
+\begin{itemize}
+\item Input Parameters Module for SWHS
+\item Logger
 \end{itemize}
 \end{itemize}
 
@@ -826,19 +896,32 @@ seq\_init():
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
 \begin{frame}
-\frametitle{Examples of Modules Continued}
-
-\begin{itemize}
+\frametitle{Examples of Modules: Abstract Data Type \cite{GhezziEtAl2003}}
 
-\item \structure{Abstract data type (ADT)}
 \begin{itemize}
+\item What you are used to for OO programming
 \item Consists of a collection of abstract objects and a collection of
   procedures that can be applied to them
 \item Defines the set of possible values for the type and the associated
   procedures that manipulate instances of the type
 \item Encapsulates the details of the implementation of the type
+\item Multiple instances of the object
+\item Keyword \textbf{Tempalate} in MIS
+\item Example
+\bi
+\item
+  \href{https://gitlab.cas.mcmaster.ca/smiths/se2aa4_cs2me3/-/blob/master/Assignments/PreviousYears/2018/A2/A2.pdf}
+  {Curve ADT Module}
+\ei
 \end{itemize}
-\item \structure{Generic Modules}
+
+\end{frame}
+
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
+\begin{frame}
+\frametitle{Examples of Modules: Generic \cite{GhezziEtAl2003}}
+
 \begin{itemize}
 \item A single abstract description for a family of abstract objects or ADTs
 \item Parameterized by type
@@ -846,8 +929,12 @@ seq\_init():
   only differ in their type information
 \item A generic module facilitates specification of a stack of integers, stack
   of strings, stack of stacks etc.
-\end{itemize}
-
+\item Example
+\bi
+\item
+  \href{https://gitlab.cas.mcmaster.ca/smiths/se2aa4_cs2me3/-/blob/master/Assignments/PreviousYears/2019/A2/A2.pdf}
+  {Generic Sequence ADT Module}
+\ei
 \end{itemize}
 
 \end{frame}