Preparations for Getting started lect (L02)

Lectures/Deadlines.tex

@@ -93,15 +93,15 @@ take it personally
 \frametitle{Presentation Sched Cont'd}
 
 %TBD
-\bi
-\item Implementation Present (15 min each)
-\bi
-%\item \textbf{Mar 26: Reyhaneh, Waqar, Al, Tanya, Atiyeh}
-% \item \textbf{Apr 2: Phil, Xinyu, Fasil, Yi-Leng}
-% \item \textbf{Apr 5: Gaofeng, Morteza, Valerie, Hunter, Ali}
-% \item \textbf{Apr 9: Cynthia, Adrian, Yiding, Kim Ying, Nada}
-\ei
-\ei
+% \bi
+% \item Implementation Present (15 min each)
+% \bi
+% \item 
+% % \item \textbf{Apr 2: Phil, Xinyu, Fasil, Yi-Leng}
+% % \item \textbf{Apr 5: Gaofeng, Morteza, Valerie, Hunter, Ali}
+% % \item \textbf{Apr 9: Cynthia, Adrian, Yiding, Kim Ying, Nada}
+% \ei
+% \ei
 
 \end{frame}
 
@@ -116,7 +116,7 @@ take it personally
 % \item Apr 5: Lesley, Deesha, Volunteer? 
 % \item Apr 6: Mina, Joachim, Maryam 
 % \ei
-\item 3 presentations each %(please check)
+\item 3 or 4 presentations each %(please check)
 \begin{itemize}
   \item SRS everyone
   \item VnV and POC subset of class

Lectures/L02_GettingStarted/GettingStarted.tex

@@ -57,6 +57,7 @@
 \bi
 \item Administrative details
 %\item Additional introductions
+\item Complete course outline
 \item Problem statements
 \item More information on Drasil
 \item Project choice discussion
@@ -67,9 +68,8 @@
 \item LaTeX
 \item Make
 \end{itemize}
-\item Questions on suggested reading?
-\item Software Engineering for Scientific Computing literature
-\item Start Projectile example
+\item Software engineering for scientific computing literature
+\item Start projectile example
 \ei
 
 \end{frame}
@@ -90,12 +90,12 @@ create a new repo
 \href{https://gitlab.cas.mcmaster.ca/smiths/cas741/-/merge_requests} {merge
 request} to modify
 \href{https://gitlab.cas.mcmaster.ca/smiths/cas741/-/blob/master/Repos.csv}
-{Repos.csv} with your project details, challenge level, extras
+{Repos.csv} with your project details, research level, extra etc.
 \item Problem statement
 \begin{itemize}
 \item
 \href{https://github.com/smiths/capTemplate/tree/main/docs/ProblemStatementAndGoals}
-{Problem statement} due Fri, Jan 19 by 11:59 pm
+{Problem statement} due Fri, Jan 17 by 11:59 pm
 \item Assign an issue to instructor to review
 \end{itemize}
 \item Feel free to add
@@ -110,16 +110,23 @@ network
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
 \begin{frame}
-\frametitle{Administrative Details: Domain Expert}
+\frametitle{Administrative Details}
 
 \begin {itemize}
 
+\item Domain Expert
+\begin{itemize}
 \item Create issues for their partner's written deliverables
 \item Asks questions during their partner's presentations
-%\item Implements one module following their partner's spec
-\item NEW: Go over final grading rubric (challenge level, extras, traceability
-between Rev 0 and Rev 1)
-
+%\item Implements one module following their partner's spec  
+\end{itemize}
+\item Final documentation grading
+\begin{itemize}
+\item Most of the grade is decided with the final documentation (60\%)
+\item Significant weighting toward responding to feedback
+\item Use the issue tracker and commits to make tracking changes easy
+\end{itemize}
+\item Required to use Continuous Integration (CI)
 \end {itemize}
 
 \end{frame}
@@ -143,6 +150,50 @@ between Rev 0 and Rev 1)
 
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
+% \begin{frame}
+% \frametitle{Course Structure}
+
+% \begin {itemize}
+
+% \item Student and instructor presentations
+% \item Classroom discussions
+% \item Will present a subset of your documentation for in-class feedback
+% \item Will do a proof of concept demonstration early in the term
+% \item Structure from our documentation
+% \item Use GitHub issue tracker for feedback from other students
+
+% \end {itemize}
+
+% \end{frame}
+
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
+\begin{frame}
+\frametitle{Challenge Level and Extra Task}
+
+\begin {itemize}
+
+\item Projects may be designed as ``research'' projects
+\item Research projects involve
+\begin{itemize}
+  \item graduate-level domain knowledge
+  \item a graduate-level implementation challenge
+\end{itemize}
+\item Non-research projects require an extra task, selected from:
+\begin{itemize}
+  \item Usability testing
+  \item User manual
+  \item Rigorous code walkthroughs
+  \item Formal proof
+  \item Other (approved by instructor)
+\end{itemize}
+\item Extras can be used as bonus grades for advanced projects
+\end {itemize}
+
+\end{frame}
+
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
 \begin{frame}[fragile]
 \frametitle{Problem Statement}
 \bi
@@ -152,8 +203,12 @@ between Rev 0 and Rev 1)
 \item Written in LaTeX (or other text-based file format)
 \item Due electronically (on GitHub) by deadline
 \item Generated files should NOT be under source control (except pdf)
+\item By default CI builds pdfs when tex files in doc folder change
 \item Comments used to give advice, you can use for your own reviews
 \item Remove comments via \verb+\newif\ifcomments\commentsfalse+
+\item Although not required, you should look at the
+\href{https://github.com/smiths/capTemplate/tree/main/docs/DevelopmentPlan}
+{Development Plan}
 \ei
 \end{frame}
 
@@ -175,7 +230,7 @@ between Rev 0 and Rev 1)
 \item Environment for the software?
 \item A page description should be sufficient
 \ei
-\item Challenge level and extras
+\item Research and extra
 \item Expected implementation decisions
 \ei
 \end{frame}
@@ -207,6 +262,10 @@ between Rev 0 and Rev 1)
 \item
   \href{https://github.com/agentvv/MTOBridge/blob/main/docs\%20Rev1/ProblemStatementAndGoals/ProblemStatement.pdf}
   {MTO Bridge}
+\item \href{https://github.com/adrian-soch/attitude_check} {IMU-based Attitude Estimation (2024)}
+\item \href{https://github.com/CynthiaLiu0805/BridgeCorrosion} {Bridge Corrosion (2024)}
+\item \href{https://github.com/omltcat/turbulent-flow} {Synthetic Eddy (2024)}
+  
 \ei
 
 \end{frame}
@@ -332,6 +391,19 @@ between Rev 0 and Rev 1)
 
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
+\begin{frame}
+\frametitle{Getting Started with Drasil}
+\begin{itemize}
+\item \href{https://github.com/JacquesCarette/Drasil/wiki/New-Workspace-Setup} {New workspace setup}
+\item \href{https://github.com/JacquesCarette/Drasil/wiki/Git2Know-for-Drasil} {Information on git}
+\item
+\href{https://github.com/JacquesCarette/Drasil/wiki/Creating-Your-Project-in-Drasil}
+{Creating your own project in Drasil}
+\end{itemize}
+\end{frame}
+
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
 \begin{frame}
 \frametitle{Project Selection Ideas/Questions}
 Let's discuss some of your project ideas
@@ -662,6 +734,26 @@ written modules
 \end{frame}
 
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
+\begin{frame}
+\frametitle{Recommended Reading Order SRS}
+
+\begin{itemize}
+
+\item Goal Statement
+\item Instance Models
+\item Requirements
+\item Introduction
+\item Specific System Description
+
+\end{itemize}
+
+Probably best to use the same order when doing your requirements presentation
+
+\end{frame}
+
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
 \begin{frame}
 \frametitle{Requirements for Projectile}
 \vspace{-1.0cm}
@@ -682,7 +774,6 @@ written modules
 
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
-
 \begin{frame}[allowframebreaks]
 \frametitle{References}
 

Repos.csv

-Num, Last Name, First Name, e-mail, GitHub ID, Supervisor, Project Name, Project Topic, Traditional or Drasil or Other, Challenge Level, Extras, GitHub Repos url, Branch, Prob State Approval?, Domain Expert Reviewer - Primary Reviewer, SRS: Secondary, VnV Plan:Secondary, MG + MIS or Drasil:Secondary
-0, Last Name, First Name, email@mcmaster.ca, githubid, Dr. X, projName, Project Title, traditional or Drasil, Advanced/General/Basic, Extras, https://github.com/..., branch, Yes/No, name, name, name, name
\ No newline at end of file
+Num, Last Name, First Name, e-mail, GitHub ID, Supervisor, Project Name, Project Topic, Traditional or Drasil or Other, Research Project (Yes or No), Extra, GitHub Repos url, Branch, Prob State Approval?, Domain Expert Reviewer, 
+0, Last Name, First Name, email@mcmaster.ca, githubid, Dr. X, projName, Project Title, traditional or Drasil, Yes/No, Usability study or user manual or code walkthrough or formal proof or other, https://github.com/..., branch, Yes/No, name
\ No newline at end of file