Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
C
cas741
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Requirements
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Locked files
Build
Pipelines
Jobs
Pipeline schedules
Test cases
Artifacts
Deploy
Releases
Model registry
Operate
Environments
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Code review analytics
Issue analytics
Insights
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
W. Spencer Smith
cas741
Commits
9a95e149
Commit
9a95e149
authored
4 years ago
by
W. Spencer Smith
Browse files
Options
Downloads
Patches
Plain Diff
Updates to getting started lecture
parent
28e2d0ca
No related branches found
Branches containing commit
No related tags found
No related merge requests found
Changes
2
Hide whitespace changes
Inline
Side-by-side
Showing
2 changed files
Lectures/L02_GettingStarted/GettingStarted.pdf
+0
-0
0 additions, 0 deletions
Lectures/L02_GettingStarted/GettingStarted.pdf
Lectures/L02_GettingStarted/GettingStarted.tex
+129
-32
129 additions, 32 deletions
Lectures/L02_GettingStarted/GettingStarted.tex
with
129 additions
and
32 deletions
Lectures/L02_GettingStarted/GettingStarted.pdf
+
0
−
0
View file @
9a95e149
No preview for this file type
This diff is collapsed.
Click to expand it.
Lectures/L02_GettingStarted/GettingStarted.tex
+
129
−
32
View file @
9a95e149
...
...
@@ -56,8 +56,9 @@
\bi
\item
Administrative details
\item
Any more introductions?
\item
Project choices
\item
Additional introductions
\item
Traditional project choices
\item
Drasil project choices
\item
Software tools
\begin{itemize}
\item
Git, GitLab and GitHub (Issue Creating Exercise)
...
...
@@ -80,16 +81,15 @@
\href
{
https://gitlab.cas.mcmaster.ca/smiths/cas741
}
{
https://gitlab.cas.mcmaster.ca/smiths/cas741
}
\item
Use folder structure given in repo (will be updating)
\item
Post any questions as issues in our repo
\item
Create a GitHub account if you don't already have one
\item
Add
\texttt
{
smiths
}
to your GitHub repos
\item
Problem statement
\begin{itemize}
\item
Problem statement due
Thurs
, Sept 1
9
by 11:59 pm
\item
Problem statement due
Mon
, Sept
2
1 by 11:59 pm
\item
Assign the instructor an issue to review your problem
statement
\end{itemize}
\item
Issue creating exercises due
Thurs
, Sept 1
9
by 10
:3
0
a
m
\item
Issue creating exercises due
Fri
, Sept 1
8
by 1
:
00
p
m
\item
Feel free to add me to you Linked-In network
\ei
...
...
@@ -104,7 +104,7 @@
\item
Creates 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 Implements one module following their partner's spec
\end
{
itemize
}
...
...
@@ -126,15 +126,16 @@
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\begin{frame}
\frametitle
{
Administrative Details: Presentations
}
\frametitle
{
Administrative Details: Presentations
(Draft Deadlines)
}
~
\newline
\begin{tabular}
{
l l l
}
SRS Present
&
Week 05
&
Week of Sept 30
\\
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
\\
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
...
...
@@ -150,16 +151,16 @@ Unit VnV or Implement Present & Week 12/13 & Week of Nov 28\\
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\begin{frame}
\frametitle
{
Administrative Details: Report Deadlines
}
\frametitle
{
Administrative Details:
Draft
Report Deadlines
}
~
\newline
\begin{tabular}
{
l l l
}
Issue Creation Exercise
&
Week 0
3
&
Sept 1
9
\\
Problem Statement
&
Week 03
&
Sept 1
9
\\
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
\\
Issue Creation Exercise
&
Week 0
2
&
Sept 1
8
\\
Problem Statement
&
Week 03
&
Sept
2
1
\\
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
\\
Final Documentation
&
Week 14
?
&
Dec 9
?
\\
\end
{
tabular
}
\bi
...
...
@@ -167,7 +168,26 @@ Final Documentation & Week 14 & Dec 9\\
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 Domain expert code due 1 week after MIS deadline
\ei
\end{frame}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\begin{frame}
\frametitle
{
Administrative Details: Optional Study Participation
}
\bi
\item
You will be contacted by Oluwaseun (Olu) Owojaiye for potential
participation in a study
\item
``Traditional'' versus ``Generative'' for software development
\item
If you participate you will be interviewed and asked to record some
details of how you spend your development time
\item
Participation is entirely voluntary
\item
The course instructor will not know who has participated
\item
Participation or non-Participation will not effect your grade
\item
Olu will visit our class on Thursday to discuss further
\ei
\end{frame}
...
...
@@ -211,8 +231,8 @@ Final Documentation & Week 14 & Dec 9\\
\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
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}
...
...
@@ -227,7 +247,8 @@ Final Documentation & Week 14 & Dec 9\\
Heated
rod
}
\item
\href
{
http://www.tech.plym.ac.uk/sme/THER204B-web/Heatran2.PDF
}{
Heated plate
}
\item
\href
{
https://en.wikipedia.org/wiki/Double
_
pendulum
}{
Double pendulum
}
\item
\href
{
https://en.wikipedia.org/wiki/Double
_
pendulum
}{
Double pendulum
(previously done)
}
\item
\href
{
http://chrishecker.com/Rigid
_
Body
_
Dynamics
}{
Rigid body dynamics
}
\item
Column buckling
\item
\href
{
https://en.wikipedia.org/wiki/Harmonic
_
oscillator
}{
Damped harmonic oscillator
}
...
...
@@ -262,18 +283,91 @@ Final Documentation & Week 14 & Dec 9\\
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\begin{frame}
\includegraphics
[width=1\textwidth]
{
../Figures/generate
_
all
_
the
_
things.jpg
}
\end{frame}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\begin{frame}
\frametitle
{
Knowledge Capture
}
\includegraphics
[width=1.0\textwidth]
{
../Figures/KC.jpg
}
\end{frame}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\begin{frame}
\frametitle
{
Drasil
}
\vspace
{
-1cm
}
\begin{center}
\includegraphics
[height=20em]
{
../Figures/tree.png
}
\end{center}
\end{frame}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\begin{frame}
\frametitle
{
Introduction to Drasil
}
\begin{itemize}
\item
Drasil uses a generative approach
\item
Knowledge is captured in a Domain Specific Language (DSL)
\item
Documentation (in tex and html) and code (in Java, C++, C
\#
, Python and
Swift) are generated
\item
Changes are propagated throughout documentation and code
\item
Consistency and completeness checks
\item
Reuse throughout document, between documents and between projects
\end{itemize}
\end{frame}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\begin{frame}
\frametitle
{
Project Selection (Drasil): Specific Physical Problems
}
\begin{itemize}
\item
Set of explicit equations with the variables of interest isolated on one
side of the equation (like
\href
{
https://jacquescarette.github.io/Drasil/examples/GlassBR/srs/GlassBR
_
SRS.html
}{
GlassBR
}
,
or
\href
{
https://jacquescarette.github.io/Drasil/examples/Projectile/srs/Projectile
_
SRS.html
}
{
Projectile
}
)
\item
First order Initial value problem (like
\href
{
https://jacquescarette.github.io/Drasil/examples/NoPCM/srs/NoPCM
_
SRS.html
}
{
NoPCM
}
)
\item
Examples
\begin{itemize}
\item
Cooling of a uniform temperature body over time
\item
Charging or discharging of a capacitor
\item
Flow into a reservoir
\item
Population growth
\item
Blood alcohol level over time
\item
\href
{
http://ugrad.math.ubc.ca/coursedoc/math103/keshet.notes/chapter11Notes.pdf
}{
Some
potential problems
}
\item
Worked example in a physics or chemistry textbook, using equations, like
solving for the forces in a statically indeterminate structure
\end{itemize}
\end{itemize}
\end{frame}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\begin{frame}
\frametitle
{
Tool Tutorials
}
\begin{itemize}
\item
Best way to learn is by doing
\item
Some getting started information and exercises in the
\href
{
https://gitlab.cas.mcmaster.ca/smiths/cas741/tree/master/ToolTutorials
}
{
ToolTutorials
}
folder, modified from undergrad classes
\href
{
https://gitlab.cas.mcmaster.ca/smiths/cas741/tree/master/ToolTutorials
}
{
ToolTutorials
}
folder, modified from undergrad classes
\item
Tutorials for
\href
{
https://gitlab.cas.mcmaster.ca/smiths/se2aa4
_
cs2me3/tree/master/Tutorials
}
{
se 2aa4 and cs 2me3
}
\item
Many other resources on-line
\item
Your colleagues can help too
\item
\href
{
https://gitlab.cas.mcmaster.ca/smiths/cas741/-/tree/master/Tools/VM
_
Instructions
}
{
Instructions for setting up a Virtual Machines
}
\end{itemize}
\end{frame}
...
...
@@ -328,14 +422,17 @@ First either init repo or clone (git init, git clone), then typical workflow is
\frametitle
{
GitLab and GitHub Issue Tracking
}
\bi
\item
\href
{
https://gitlab.cas.mcmaster.ca/smiths/cas741/tree/master/ToolTutorials/gitAndGitLab
}{
See brief document in course repo
}
\item
\href
{
https://github.com/JacquesCarette/literate-scientific-software/issues
}{
See
examples
}
\item
\href
{
https://gitlab.cas.mcmaster.ca/smiths/cas741/tree/master/ToolTutorials/gitAndGitLab
}
{
See brief document in course repo
}
\item
\href
{
https://github.com/JacquesCarette/literate-scientific-software/issues
}
{
See examples
}
\item
Tutorials for
\href
{
https://gitlab.cas.mcmaster.ca/smiths/se2aa4
_
cs2me3/tree/master/Tutorials/T01a-Git/slides
}
{
se 2aa4 and cs 2me3
}
\item
\href
{
https://gitlab.cas.mcmaster.ca/smiths/cas741/issues
}{
Create an
issue
}
\ei
\item
\href
{
https://gitlab.cas.mcmaster.ca/smiths/cas741/issues
}
{
Create an
issue
}
\ei
\end{frame}
...
...
@@ -345,7 +442,7 @@ First either init repo or clone (git init, git clone), then typical workflow is
\frametitle
{
Issue Creating Exercise
}
\bi
\item
Due by
Thurs
, Sept 1
9
, 10
:3
0
a
m
\item
Due by
Friday
, Sept 1
8
, 1
:
00
p
m
\item
Create 2 to 3 issues for case studies in Drasil repo
\item
\href
{
https://jacquescarette.github.io/Drasil/
}
{
https://jacquescarette.github.io/Drasil/
}
...
...
@@ -435,7 +532,7 @@ scientific software.
\item
or a knowledge acquisition driven process~
\cite
{
Kelly2015
}
.
\ei
\item
Scientists do not view rigid, process-heavy approaches,
favorably~
\cite
{
CarverEtAl2007
}
favo
u
rably~
\cite
{
CarverEtAl2007
}
\item
Reports for each stage of development are counterproductive~
\cite
[p.~373]
{
Roache1998
}
\item
Up-front requirements are
impossible~
\cite
{
CarverEtAl2007, SegalAndMorris2008
}
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment