Skip to content
Snippets Groups Projects
Commit 4b0c429e authored by W. Spencer Smith's avatar W. Spencer Smith
Browse files

Updates to L02, L03 and L05

parent ebd602a2
No related branches found
No related tags found
No related merge requests found
Hide whitespace changes
Inline Side-by-side
Showing
with 65 additions and 133 deletions
Lectures/Deadlines.tex
+ 7
− 7
View file @ 4b0c429e
......@@ -5,18 +5,18 @@
~\newline
\begin{tabular}{l l l}
SRS Present & Week 03/04 & Week of Jan 16, 23\\
Syst.\ VnV Present & Week 06 & Week of Feb 13\\
SRS & Week 03/04 & Week of Jan 16, 23\\
Syst.\ VnV & Week 06 & Week of Feb 13\\
POC Demo & Week 06, 07 & Week of Feb 13, 27\\
MG + MIS Syntax Present & Week 09 & Week of Mar 13\\
MIS Semantics Present & Week 09 & Week of Mar 13\\
Unit VnV or Implement Present & Week 11/12 & Week of Mar 27, Apr 3\\
Drasil Present & Week 11/12 & Week of Mar 27, Apr 3\\
MG + MIS Syntax & Week 09 & Week of Mar 13\\
MIS Semantics & Week 09 & Week of Mar 13\\
Unit VnV/Implement & Week 11/12 & Week of Mar 27, Apr 3\\
Drasil & Week 11/12 & Week of Mar 27, Apr 3\\
\end {tabular}
\bi
%\item Very tentative dates
\item Specific schedule depends on final class registration and need
\item Specific schedule depends on final class registration
\item Informal presentations with the goal of improving everyone's written
deliverables
\item Domain experts and secondary reviewers (and others) will ask questions
......
Lectures/L02_GettingStarted/GettingStarted.pdf
+ 0
− 0
View file @ 4b0c429e
No preview for this file type
Lectures/L02_GettingStarted/GettingStarted.tex
+ 2
− 1
View file @ 4b0c429e
......@@ -91,7 +91,7 @@ request} to modify
\begin{itemize}
\item
\href{https://github.com/smiths/capTemplate/tree/main/docs/ProblemStatementAndGoals}
{Problem statement} due Mon, Jan 21 by 11:59 pm
{Problem statement} due Fri, Jan 20 by 11:59 pm
\item Assign an issue to instructor to review
\end{itemize}
\item Feel free to add
......@@ -167,6 +167,7 @@ network
\bi
\item Stakeholders?
\item Environment for the software?
\item A page description should be sufficient
\ei
\ei
\end{frame}
......
Lectures/L03_Requirements/Requirements.pdf
+ 0
− 0
View file @ 4b0c429e
No preview for this file type
Lectures/L03_Requirements/Requirements.tex
+ 43
− 124
View file @ 4b0c429e
......@@ -49,12 +49,11 @@
\bi
\item Administrative details
\item You should all now be able to access
\href{https://gitlab.cas.mcmaster.ca/smiths/pub} {the publications repo}
\item Student Introductions
\item Questions: project choices?, software tools?
\item Problem statement and example
\item Software Engineering for Scientific Computing literature
\item Scientific Computing Software Qualities (online video)
\item Problem statement questions?
%\item Software Engineering for Scientific Computing literature
\item Scientific Computing Software Qualities
\item Motivation: Challenges to Developing Quality Scientific Software
\item Requirements documentation for scientific computing
\item A requirements template
......@@ -62,7 +61,6 @@
\item The template from a software engineering perspective
\item Concluding remarks
\item References
\item Olu visit about optional study participation
\ei
\end{frame}
......@@ -74,80 +72,54 @@
\bi
% \item Can everyone access GitLab?
% \href{https://gitlab.cas.mcmaster.ca/smiths/cas741}{https://gitlab.cas.mcmaster.ca/smiths/cas741}
\item Create a GitHub account if you don't already have one
\item Add \texttt{smiths} to your GitHub repos
\item Linked-In
\item \structure{Assign the instructor an issue to review your problem
statement - Due by Mon, Sept 21 by 11:59 pm}
\item Issue creating exercises
\begin{itemize}
\item due Fri, Sept 18 by 1:00 pm
\item \textbf{No more issues related to document formatting please :-)}
\item Issues that are questions are fine
\item \href{https://github.com/JacquesCarette/Drasil/issues/2248} {Example of
question label}
\item \href{https://github.com/JacquesCarette/Drasil/issues/2242} {Example of
``at'', and traceability}
\item One issue, per issue
\item \href{https://github.com/JacquesCarette/Drasil/issues/2241} {Connection to
commit and pull request}
\item screenshots, links, full description
\end{itemize}
\item Accounts requested for all non-CAS students to access
\href{https://gitlab.cas.mcmaster.ca/smiths/pub} {the publications repo}
\item Use the \href{https://github.com/smiths/capTemplate} {GitHub template} to
create a new repo
\item Add \texttt{smiths} to your GitHub repo
\item Create a fork and a
\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
\ei
\end{frame}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\begin{frame}
\frametitle{Administrative Details: Presentations (Draft Deadlines)}
~\newline
\begin{tabular}{l l l}
SRS Present & Week 05? & Week of Sept 30?\\
POC Demo & Week 06? & Week of Oct 6?\\
Syst.\ VnV Present & Week 07? & Week of Oct 21?\\
MG + MIS Syntax Present & Week 9? & Week of Nov 4?\\
MIS Semantics Present & Week 11? & Week of Nov 18?\\
Unit VnV or Implement Present & Week 12/13? & Week of Nov 28?\\
\end {tabular}
\bi
%\item Very tentative dates
\item Specific schedule depends on final class registration and need
\item Informal presentations with the goal of improving everyone's written
deliverables
\item Domain experts and secondary reviewers (and others) will ask questions
\ei
\end{frame}
\input{../Deadlines.tex}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\begin{frame}
\frametitle{Administrative Details: Draft Report Deadlines}
~\newline
\begin{tabular}{l l l}
Issue Creation Exercise & Week 02 & Sept 18\\
Problem Statement & Week 03 & Sept 21\\
System Requirements Specification (SRS) & Week 06? & Oct 7?\\
System VnV Plan & Week 08? & Oct 28?\\
Module Guide (MG) + Mod Int Spec (MIS)? & Week 10? & Nov 25?\\
%Unit VnV Plan & Week 14 & Dec 3\\
Final Documentation & Week 14? & Dec 9?\\
\end {tabular}
\frametitle{Introductions}
\begin{itemize}
\item Your name
\item Degree program
\item Academic background
\item Experience with:
\begin{itemize}
\item Science (such as physics)
\item Scientific computing
\item Continuous math
\item Discrete math
\item Software engineering
\item Software development technology
\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 Two days after each major deliverable, your GitHub issues will be due
%\item Domain expert code due 1 week after MIS deadline
\item Git
\item GitHub or GitLab
\item LaTeX
\item Make etc.
\ei
\end{itemize}
\item What do you hope to get out of this course?
\end{itemize}
\end{frame}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\begin{frame}
\frametitle{Questions?}
......@@ -158,71 +130,18 @@ Final Documentation & Week 14? & Dec 9?\\
\item git?
\item LaTex?
\ei
\item Partial tex files in the blank project template
\item
\href{https://gitlab.cas.mcmaster.ca/smiths/cas741/tree/master/BlankProjectTemplate/docs/ProblemStatement}
{Problem statement}
\href{https://gitlab.cas.mcmaster.ca/smiths/cas741/-/blob/master/BlankProjectTemplate/docs/ProblemStatement/ProbState-Checklist.pdf}
{Checklist for Problem Statement}
\item Copy the folder structure and README files from the blank project, but
wait for tex files for deliverables
\item Questions about
\href{https://github.com/smiths/capTemplate/tree/main/docs/ProblemStatementAndGoals}
{Problem statement and goals}? (also see \href
{https://github.com/smiths/capTemplate/blob/main/docs/Checklists/ProbState-Checklist.pdf}
{prob state checklist} and
\href{https://github.com/smiths/capTemplate/blob/main/docs/Checklists/Writing-Checklist.pdf}
{writing checklist})
\end{itemize}
\end{frame}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\begin{frame}
\frametitle{Problem Statement}
\bi
\item Written in LaTeX
\item Due electronically (on GitHub) by deadline
\item Generated files should NOT be under source control (except pdf)
\item Comments might be typed directly into your source
\item Include the \LaTeX{} commands for comments
\item \textbf{What} problem are you trying to solve?
\item \textbf{Not how} you are going to solve the problem
\item What are the inputs and the outputs?
\item Why is this an important problem?
\item What is the context of the problem you are solving?
\bi
\item Who are the stakeholders? (``fake it'' so it is not 741 specific)
\item What is the environment for the software?
\ei
\item A page description (max) should be sufficient
\ei
\end{frame}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\begin{frame}
\frametitle{Sample Project Statements}
\bi
\item
\href{https://gitlab.cas.mcmaster.ca/smiths/cas741/-/blob/master/BlankProjectTemplate/docs/Writing-Checklist.pdf}
{Writing Checklist}
\item
\href{https://gitlab.cas.mcmaster.ca/smiths/cas741/-/blob/master/BlankProjectTemplate/docs/ProblemStatement/ProbState-Checklist.pdf}
{Problem Statement Checklist}
\item
\href{https://github.com/icbicket/SpectrumImageAnalysisPy/blob/master/Doc/ProblemStatement/ProblemStatement.tex}
{SpectrumImageAnalysisPy}
\item
\href{https://github.com/palmerst/cas741_sp/blob/master/Doc/ProblemStatement/ProblemStatement.pdf}{Aqueous
Speciation Diagram Generator}
\item
\href{https://github.com/aoananp/cas741/blob/master/Doc/ProblemStatement/ProblemStatement.pdf}{System
of ODE solver library}
\item \href{https://gitlab.cas.mcmaster.ca/ThisTooShallParse/3XA3_CParser}{CParser}
\item \href{https://gitlab.cas.mcmaster.ca/theateam/FloppyFishGroup}{FloppyFish}
\item
\href{https://gitlab.cas.mcmaster.ca/screenholders/screenholders}{Screenholders}
\ei
\end{frame}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\begin{frame}
\frametitle{Definition of Software Qualities}
......
Lectures/L05_ProgramFamilies/ProgramFamilies.pdf
+ 0
− 0
View file @ 4b0c429e
No preview for this file type
Lectures/L05_ProgramFamilies/ProgramFamilies.tex
+ 13
− 1
View file @ 4b0c429e
......@@ -65,7 +65,6 @@
\bi
\item Record lecture
\item Olu's research project
\item Administrative details
\item Questions?
\item Finish up on SRS
......@@ -112,6 +111,19 @@
\item Ask at least one question after presentation
\item By two days after each major deliverable, create at least 5 GitHub issues
\ei
\item Creating issues as a reviewer
\begin{itemize}
\item \textbf{No more issues related to document formatting please :-)}
\item Issues that are questions are fine
\item \href{https://github.com/JacquesCarette/Drasil/issues/2248} {Example of
question label}
\item \href{https://github.com/JacquesCarette/Drasil/issues/2242} {Example of
``at'', and traceability}
\item One issue, per issue
\item \href{https://github.com/JacquesCarette/Drasil/issues/2241} {Connection to
commit and pull request}
\item screenshots, links, full description
\end{itemize}
%\item 80 columns in tex files
%\item Spell check
......
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment