summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorChristian Kolset <christian.kolset@gmail.com>2025-04-29 19:02:29 -0600
committerChristian Kolset <christian.kolset@gmail.com>2025-04-29 19:02:29 -0600
commiteb2830349fd1892ec68659c22bab73f26255e268 (patch)
treea44991051ad8374f36b8289bf6c45bc4679277cf
parentd0f224c34e0a0726274c62e9fe66220af6d2e6cc (diff)
Fixed minor syntax issues with formating of markdown and latex files
-rw-r--r--book/computingME.pdfbin4057638 -> 4060639 bytes
-rw-r--r--book/module1/array.tex12
-rw-r--r--book/module1/basics_of_python.tex44
-rw-r--r--book/module1/jupyter_lab_notebook.tex20
-rw-r--r--book/module2/error.tex4
-rw-r--r--tutorials/module_1/array.md2
-rw-r--r--tutorials/module_1/basics_of_python.md2
-rw-r--r--tutorials/module_1/jupyter_lab_notebook.md2
8 files changed, 62 insertions, 24 deletions
diff --git a/book/computingME.pdf b/book/computingME.pdf
index 572b469..4ef935c 100644
--- a/book/computingME.pdf
+++ b/book/computingME.pdf
Binary files differ
diff --git a/book/module1/array.tex b/book/module1/array.tex
index 9482065..e442ba6 100644
--- a/book/module1/array.tex
+++ b/book/module1/array.tex
@@ -35,7 +35,19 @@ the value of the element as a property. In other words, if we were to
analyze the stress concentration of an aluminum block, the property
would be stress.
+\begin{itemize}
+\tightlist
+\item
+ From
+ \href{https://numpy.org/doc/2.2/user/absolute_beginners.html}{Numpy
+ documentation}
+\end{itemize}
+
+\begin{figure}
+\centering
\includegraphics{figures/multi-dimensional-array.png}
+\caption{Mathworks 3-D array}
+\end{figure}
If the load on this block changes over time, then we may want to add a
4th dimension i.e.~additional sets of 3-D arrays for each time
diff --git a/book/module1/basics_of_python.tex b/book/module1/basics_of_python.tex
index 4b9db05..a68400e 100644
--- a/book/module1/basics_of_python.tex
+++ b/book/module1/basics_of_python.tex
@@ -10,26 +10,40 @@ syntax, operators, order or precedence and more.
In python \emph{indentations} or the space at the start of each line,
signifies a block of code. This becomes important when we start working
with function and loops. We will talk more about this in the controls
-structures tutorial. \#\#\# Comments Comments can be added to your code
-using the hash operator (\#). Any text behind the comment operator till
-the end of the line will be rendered as a comment. If you have an entire
-block of text or code that needs to be commented out, the triple
-quotation marks (``\,``\,``) can be used. Once used all the code after
-it will be considered a comment until the comment is ended with the
-triple quotation marks.f
+structures tutorial.
+
+\subsubsection{Comments}\label{comments}
+
+Comments can be added to your code using the hash operator (\#). Any
+text behind the comment operator till the end of the line will be
+rendered as a comment. If you have an entire block of text or code that
+needs to be commented out, the triple quotation marks (``\,``\,``) can
+be used. Once used all the code after it will be considered a comment
+until the comment is ended with the triple quotation marks.f
\subsection{Operators}\label{operators}
In python, operators are special symbols or keywords that perform
operations on values or variables. This section covers some of the most
-common operator that you will see in this course. \#\#\# Arithmetic
-operators \textbar{} Operator \textbar{} Name \textbar{} \textbar{} ---
-\textbar{} --- \textbar{} \textbar{} + \textbar{} Addition \textbar{}
-\textbar{} - \textbar{} Subtraction \textbar{} \textbar{} * \textbar{}
-Multiplication \textbar{} \textbar{} / \textbar{} Division \textbar{}
-\textbar{} \% \textbar{} Modulus \textbar{} \textbar{} ** \textbar{}
-Exponentiation \textbar{} \textbar{} // \textbar{} Floor division
-\textbar{}
+common operator that you will see in this course.
+
+\subsubsection{Arithmetic operators}\label{arithmetic-operators}
+
+\begin{longtable}[]{@{}ll@{}}
+\toprule\noalign{}
+Operator & Name \\
+\midrule\noalign{}
+\endhead
+\bottomrule\noalign{}
+\endlastfoot
++ & Addition \\
+- & Subtraction \\
+* & Multiplication \\
+/ & Division \\
+\% & Modulus \\
+** & Exponentiation \\
+// & Floor division \\
+\end{longtable}
\subsubsection{Comparison operators}\label{comparison-operators}
diff --git a/book/module1/jupyter_lab_notebook.tex b/book/module1/jupyter_lab_notebook.tex
index c08fd74..b7d9353 100644
--- a/book/module1/jupyter_lab_notebook.tex
+++ b/book/module1/jupyter_lab_notebook.tex
@@ -95,9 +95,12 @@ hashes determines whether it's a sub-title \texttt{\#}, \texttt{\#\#},
There are two types of list in - Bullet lists: \texttt{-\ item} -
Numbered lists: \texttt{1.\ item} \#\#\# Style - Emphasis:
-\emph{italic}, \textbf{bold}, \texttt{monospace} \#\#\# Mathematical
-Equation Markdown supports LaTeX format equations. Inline equation is
-opened and closed with a single \texttt{\$}. For a block math a double
+\emph{italic}, \textbf{bold}, \texttt{monospace}
+
+\subsubsection{Mathematical Equation}\label{mathematical-equation}
+
+Markdown supports LaTeX format equations. Inline equation is opened and
+closed with a single \texttt{\$}. For a block math a double
\texttt{\$\$} is used instead of single.
\begin{itemize}
@@ -108,12 +111,15 @@ opened and closed with a single \texttt{\$}. For a block math a double
\item
Block: Whilst this is a block:
\texttt{\$\$\textbackslash{}int\_0\^{}\textbackslash{}infty\ e\^{}\{-x\^{}2\}\ dx\ =\ \textbackslash{}frac\{\textbackslash{}sqrt\{\textbackslash{}pi\}\}\{2\}\$\$}
- \#\#\# Links and images You can insert links to a different local file
- or online urls like this: {[}Link{]}(file.md). I insert an image it's
- the same however start with an exclamation mark \texttt{!} like this:
- !{[}Image Caption{]}(picture.png)
\end{itemize}
+\subsubsection{Links and images}\label{links-and-images}
+
+You can insert links to a different local file or online urls like this:
+{[}Link{]}(file.md). I insert an image it's the same however start with
+an exclamation mark \texttt{!} like this: !{[}Image
+Caption{]}(picture.png)
+
\subsection{Exporting and Sharing}\label{exporting-and-sharing}
To export your notebook go to
diff --git a/book/module2/error.tex b/book/module2/error.tex
index 758a206..2646dc8 100644
--- a/book/module2/error.tex
+++ b/book/module2/error.tex
@@ -29,9 +29,9 @@ part of the computation}. An example of this could be using a finite
number of terms from a Taylor Series expansion to approximate a
function.
-Approximating $e^x$ by the first few terms of its Taylor series:
+Approximating \(e^x\) by the first few terms of its Taylor series:
-$e^x \approx 1 + x + \frac{x^2}{2!} + \frac{x^3}{3!}​\$
+\[e^x \approx 1 + x + \frac{x^2}{2!} + \frac{x^3}{3!}​\]
The error comes from \textbf{neglecting} all the higher order terms
(\(\frac{x^4}{4!}, \frac{x^5}{5!}\), \ldots).
diff --git a/tutorials/module_1/array.md b/tutorials/module_1/array.md
index 9fa1c88..164d53d 100644
--- a/tutorials/module_1/array.md
+++ b/tutorials/module_1/array.md
@@ -15,6 +15,8 @@ A two-dimensional array would be like a table:
A three-dimensional array would be like a set of tables, perhaps stacked as though they were printed on separate pages. If we visualize the position of each element as a position in space. Then we can represent the value of the element as a property. In other words, if we were to analyze the stress concentration of an aluminum block, the property would be stress.
- From [Numpy documentation](https://numpy.org/doc/2.2/user/absolute_beginners.html)
+
+
![Mathworks 3-D array](figures/multi-dimensional-array.png)
If the load on this block changes over time, then we may want to add a 4th dimension i.e. additional sets of 3-D arrays for each time increment. As you can see - the more dimensions we add, the more complicated of a problem we have to solve. It is possible to increase the number of dimensions to the n-th order. This course we will not be going beyond dimensional analysis.
diff --git a/tutorials/module_1/basics_of_python.md b/tutorials/module_1/basics_of_python.md
index 7654e92..0df9296 100644
--- a/tutorials/module_1/basics_of_python.md
+++ b/tutorials/module_1/basics_of_python.md
@@ -5,12 +5,14 @@ This page contains important fundamental concepts used in Python such as syntax,
## Syntax
### Indentations and blocks
In python *indentations* or the space at the start of each line, signifies a block of code. This becomes important when we start working with function and loops. We will talk more about this in the controls structures tutorial.
+
### Comments
Comments can be added to your code using the hash operator (#). Any text behind the comment operator till the end of the line will be rendered as a comment.
If you have an entire block of text or code that needs to be commented out, the triple quotation marks (""") can be used. Once used all the code after it will be considered a comment until the comment is ended with the triple quotation marks.f
## Operators
In python, operators are special symbols or keywords that perform operations on values or variables. This section covers some of the most common operator that you will see in this course.
+
### Arithmetic operators
| Operator | Name |
| --- | --- |
diff --git a/tutorials/module_1/jupyter_lab_notebook.md b/tutorials/module_1/jupyter_lab_notebook.md
index ab52654..ad5d7b5 100644
--- a/tutorials/module_1/jupyter_lab_notebook.md
+++ b/tutorials/module_1/jupyter_lab_notebook.md
@@ -47,11 +47,13 @@ There are two types of list in
- Numbered lists: `1. item`
### Style
- Emphasis: _italic_, **bold**, `monospace`
+
### Mathematical Equation
Markdown supports LaTeX format equations. Inline equation is opened and closed with a single `$`. For a block math a double `$$` is used instead of single.
- Inline: This equation is inline `$E = mc^2$` in with the markdown text.
- Block: Whilst this is a block: `$$\int_0^\infty e^{-x^2} dx = \frac{\sqrt{\pi}}{2}$$`
+
### Links and images
You can insert links to a different local file or online urls like this: \[Link](file.md). I insert an image it's the same however start with an exclamation mark `!` like this: !\[Image Caption](picture.png)