more text and references

Author: thomasWeise

bibliography/bibliography.bib

@@ -2,6 +2,10 @@
 %%% The acronyms.
 %%%
 %
+\newacronym{AI}{AI}{Artificial Intelligence}%
+\newacronym{DS}{DS}{Data Science}%
 \newacronym[description={Integrated Development Environment, see \gls{ide}}]{IDE}{IDE}{Integrated Development Environment}%
+\newacronym{ML}{ML}{Machine Learning}%
+\newacronym[description={Operating System, the system that runs your computer, see, e.g., \linux\ and \windows}]{OS}{OS}{Operating System}%
 \newacronym[description={Version Control Systems, see \gls{vcs}}]{VCS}{VCS}{Version Control Systems}%
 %

notation/acronyms.sty

@@ -2,61 +2,137 @@
 %% Access to Source Codes
 %%
 %
-\protected\gdef\softwareStyle#1{\textrm{#1}}%
-%
-\newglossaryentry{python}{%
-name={\softwareStyle{Python}},
-sort={Python},
-description={The \href{https://python.org/}{\softwareStyle{Python}} programming language, i.e., what you will learn about in this book.}
-}%
-\protected\gdef\python{\gls{python}}%
-%
-\xdef\pythonVersion{3.10}%
-\protected\gdef\pythonWithVersion{\softwareStyle{\python~\pythonVersion}}%
+\protected\gdef\softwareStyle#1{\scalebox{0.95}[1]{\texttt{#1}}}%
 %
 %
 \newglossaryentry{linux}{%
 name={\softwareStyle{Linux}},
 sort={Linux},
 description={%
-is an open source operating system, i.e., a free alternative for \windows. %
+is the leading open source operating system, i.e., a free alternative for \windows~\cite{T1999TLE}. %
 Its variant \ubuntu\ is particularly easy to use and install. %
-We recommend using it for this course, for software development, and for research.%
+We recommend using it for this course, for software development, and for research. %
+Learn more at \url{https://www.linux.org/}.%
 }%
 }%
-\protected\gdef\linux{\gls{linux}}%
+\protected\gdef\linux{\pgls{linux}}%
+%
+%
+\newglossaryentry{matplotlib}{%
+name={\softwareStyle{Matplotlib}},
+sort={Matplotlib},
+description={%
+is a \python\ package for plotting diagrams and charts~\cite{H2007MA2GE}. %
+Learn more at at \url{https://matplotlib.org}.%
+}%
+}%
+\protected\gdef\matplotlib{\pgls{matplotlib}}%
+%
+%
+\newglossaryentry{moptipy}{%
+name={\softwareStyle{moptipy}},
+sort={moptipy},
+description={%
+is the \emph{Metaheuristic Optimization in \python} library~\cite{WW2023RSDEWASSAA}. %
+Learn more at \url{https://thomasweise.github.io/moptipy}.%
+}%
+}%
+\protected\gdef\moptipy{\pgls{moptipy}}%
+%
+\newglossaryentry{numpy}{%
+name={\softwareStyle{NumPy}},
+sort={NumPy},
+description={%
+is a fundamental package for scientific computing with \python, which offers efficient array datastructures~\cite{HMvdWGVCWTBSKPHvKBHFdRWPGMSRWAGO2020APWN}. %
+Learn more at \url{https://numpy.org/}.%
+}%
+}%
+\protected\gdef\numpy{\pgls{numpy}}%
+%
+%
+\newglossaryentry{pandas}{%
+name={\softwareStyle{Pandas}},
+sort={Pandas},
+description={%
+is a \python\ data analysis and manipulation library~\cite{B2012DPWP}. %
+Learn more at \url{https://pandas.pydata.org}.%
+}%
+}%
+\protected\gdef\pandas{\pgls{pandas}}%
 %
 %
 \newglossaryentry{pycharm}{%
 name={\softwareStyle{PyCharm}},
 sort={PyCharm},
 description={%
-is the convenient \python\ \gls{ide} that we recommend for this course.%
+is the convenient \python\ \pgls{ide} that we recommend for this course~\cite{VHN2023HOADWP}. %
+Learn more at \url{https://www.jetbrains.com/pycharm}.%
+}%
+}%
+\protected\gdef\pycharm{\pgls{pycharm}}%
+%
+%
+\newglossaryentry{python}{%
+name={\softwareStyle{Python}},
+sort={Python},
+description={The \softwareStyle{Python} programming language~\cite{H2023ABGTP3P,LH2015DSAAWP}, i.e., what you will learn about in this book. %
+Learn more at \url{https://python.org}.}
 }%
+\protected\gdef\python{\pgls{python}}%
+%
+\xdef\pythonVersion{3.10}%
+\protected\gdef\pythonWithVersion{\softwareStyle{\python~\pythonVersion}}%
+%
+%
+\newglossaryentry{scikitlearn}{%
+name={\softwareStyle{Scikit-learn}},
+sort={Scikit-learn},
+description={is a \python\ library offering various machine learning tools~\cite{PVGMTGBPWDVPCBPD2011SMLIP}. %
+Learn more at \url{https://scikit-learn.org}.}
+}%
+\protected\gdef\scikitlearn{\pgls{scikitlearn}}%
+%
+%
+\newglossaryentry{scipy}{%
+name={\softwareStyle{SciPy}},
+sort={SciPy},
+description={is a \python\ library for scientific computing~\cite{VGOHRCBPWBvdWBWMMNJKLCPFMVLPCHQHARPvMS2020SFAFSCIP}. %
+Learn more at \url{https://scipy.org}.}
+}%
+\protected\gdef\scipy{\pgls{scipy}}%
+%
+%
+\newglossaryentry{tensorflow}{%
+name={\softwareStyle{TensorFlow}},
+sort={TensorFlow},
+description={is a \python\ library for implementing machine learning, especially suitable for training of neural networks~\cite{ABCCDDDGIIKLMMMSTVWWYZ2016TASFLSML}. %
+Learn more at \url{https://www.tensorflow.org}.}
 }%
-\protected\gdef\pycharm{\gls{pycharm}}%
+\protected\gdef\tensorflow{\pgls{tensorflow}}%
 %
 %
 \newglossaryentry{ubuntu}{%
 name={\softwareStyle{Ubuntu}},
 sort={Ubuntu},
 description={%
-is a variant of the open source operating system \linux. %
+is a variant of the open source operating system \linux~\cite{CN2020ULB}. %
 We recommend that you use this operating system to follow this class, for software development, and for research. %
+Learn more at \url{https://ubuntu.com}. %
 If you are in China, you can download it from \expandafter\url{\ubuntuDownloadUrl}.%
 }%
 }%
-\protected\gdef\ubuntu{\gls{ubuntu}}%
-\xdef\ubuntuDownloadUrl{https://mirrors.ustc.edu.cn/ubuntu-releases/}%
+\protected\gdef\ubuntu{\pgls{ubuntu}}%
+\xdef\ubuntuDownloadUrl{https://mirrors.ustc.edu.cn/ubuntu-releases}%
 %
 %
 \newglossaryentry{windows}{%
 name={\softwareStyle{Windows}},
 sort={Windows},
 description={%
-\href{https://www.microsoft.com/windows/}{\softwareStyle{Microsoft Windows}} is a commerical proprietary operating system. %
-It is widely spread, but we recommend using a \linux\ variant such as \ubuntu\ for software development and for our course.%
+Microsoft~\softwareStyle{Windows} is a commerical proprietary operating system~\cite{B2023W1IO}. %
+It is widely spread, but we recommend using a \linux\ variant such as \ubuntu\ for software development and for our course. %
+Learn more at \url{https://www.microsoft.com/windows}.%
 }%
 }%
-\protected\gdef\windows{\gls{windows}}%
+\protected\gdef\windows{\pgls{windows}}%
 %

notation/software.sty

@@ -5,9 +5,21 @@
 \newglossaryentry{git}{%
 name={Git},
 description={%
-Git is a distributed \acrfull{VCS} which allows multiple users to work on the same code while preserving the history of the code changes.%
+Git is a distributed \acrfull{VCS} which allows multiple users to work on the same code while preserving the history of the code changes~\cite{S2023LG,T2024BGAGVCPMATFTND}.%
 }%
 }%
+\protected\gdef\git{\pgls{git}}
+%
+%
+\newglossaryentry{github}{%
+name={GitHub},
+description={%
+GitHub is a website where software projects can be hosted and managed via the \pgls{git} \pgls{vcs}~\cite{PRGWSUdVLFTEKPKFBV2016TSRFTAOGAG,T2024BGAGVCPMATFTND}. %
+Learn more at \url{https://github.com}.%
+}%
+}%
+\protected\gdef\github{\pgls{github}}
+%
 %
 \newglossaryentry{ide}{%
 name={Integrated Development Environment},
@@ -24,7 +36,7 @@ For this course, we recommend using \pycharm.%
 name={\texttt{sudo}},
 sort={sudo},
 description={%
-In order to perform administrative tasks such as installing new software under \linux, root (or ``super'') user privileges as needed. %
+In order to perform administrative tasks such as installing new software under \linux, root (or ``super'') user privileges as needed~\cite{CN2020ULB}. %
 A normal user can execute a program in the \gls{terminal} as super user by pre-pending \bashil{sudo}, often referred to as ``super user do.'' %
 This requires the root password.%
 }%
@@ -35,18 +47,19 @@ This requires the root password.%
 name={terminal},
 plural={terminals},
 description={%
-A terminal is a text-based window where you can enter commands and execute them by pressing \keys{\return}. %
+A terminal is a text-based window where you can enter commands and execute them~\cite{CN2020ULB}. %
 Knowing what a terminal is and how to use it is very essential in any programming- or system administration-related task. %
 If you want to open a terminal under \windows, you can \windowsTerminal, as shown, e.g., in \cpageref{fig:installingPythonWindows01openTerminal}. %
 Under \ubuntu\ \linux, \ubuntuTerminal\ opens a terminal.%
 }%
 }%
 %
+%
 \newglossaryentry{vcs}{%
 name={Version Control System},
 plural={Version Control Systems},
 description={%
-A \acrfull{VCS} is a software which allows you to manage and preserve the historical development of your program code. %
+A \acrfull{VCS} is a software which allows you to manage and preserve the historical development of your program code~\cite{T2024BGAGVCPMATFTND}. %
 A distributed \gls{VCS} allows multiple users to work on the same code and upload their changes to the server, which then preserves the change history.
 The most popular distributed \gls{VCS} is \gls{git}.%
 }%

notation/terms.sty

@@ -79,3 +79,25 @@ description={\sloppy#4.}%
 \expandafter\protected\expandafter\gdef\csname#1\endcsname{\ensuremath{\gls{#1}}}%
 \expandafter\protected\expandafter\gdef\csname#1Of\endcsname##1{\ensuremath{##1_{\gls{#1}}}}%
 }%
+%
+%% Create a command #1 that evaluates to #2 exactly once per page and to #3 afterwards.
+\protected\gdef\oncePerPage#1#2#3{%
+\expandafter\protected\expandafter\gdef\csname @#1A\endcsname{%
+#2%
+\expandafter\protected\expandafter\gdef\csname #1\endcsname{\csname @#1B\endcsname}%
+\afterpage{\expandafter\protected\expandafter\gdef\csname #1\endcsname{\csname @#1A\endcsname}}%
+}%
+\expandafter\protected\expandafter\gdef\csname @#1B\endcsname{#3}%
+\expandafter\protected\expandafter\gdef\csname #1\endcsname{\csname @#1A\endcsname}%
+}%
+%
+%%
+%% Invoke the glossary term, but link only once per page.
+%%
+\protected\gdef\pgls#1{%
+\expandafter\ifcsname @@@@#1\endcsname\else%
+\oncePerPage{@@@@#1}{\gls{#1}}{\gls[hyper=false]{#1}}%
+\fi%
+\expandafter\csname @@@@#1\endcsname%
+}%
+%

styles/glossary.sty

@@ -4,17 +4,25 @@
 In order to do practical things, we need to have all the necessary software on our computer.
 What software is necessary to do \python\ programming?
 Well, first of all, \python.
-If \python\ is not yet installed on your machine, then we briefly outline in \cref{sec:installingPython} how you can install it.
+If \python\ is not yet installed on your machine, then you can follow brief installation guide in \cref{sec:installingPython}.
 
 Now with the programming language \python\ alone, you cannot really do much -- in a convenient way, at least.
 You need a nice editor in which you can write the programs.
 Actually, you want an editor where you can not just write programs.
 You want an editor  where you can also directly execute and test your programs.
-In software development, you often work with a \gls{VCS} like \gls{git}.
+In software development, you often work with a \pgls{VCS} like \git.
 You want to do that convenient from your editor.
-Such an editor, which integrates many of the common tasks that occur during programming, is called an \gls{IDE}.
-In our course, you will work with the \pycharm\ \gls{IDE}.
-If you do not yet have \pycharm\ installed, in \cref{sec:installingPyCharm} we give a brief summary on how you can install it.%
+Such an editor, which integrates many of the common tasks that occur during programming, is called an \pgls{IDE}.
+In our course, you will work with the \pycharm\ \pgls{IDE}~\cite{VHN2023HOADWP}.
+If you do not yet have \pycharm\ installed, then you can work through the setup instructions outlined in \cref{sec:installingPyCharm}.
+
+Before we get into these necessary installation and setup steps that we need to really learn programming, we face a small problem:
+Today, devices with many different \pgls{OS} are available.
+For each \pgls{OS}, the installation steps and software availability may be different, so I cannot possibly cover them all.
+Personally, I strongly recommend using \linux~\cite{T1999TLE} for programming, work, and research.
+If you are a student of computer science or any related field, then it is my personal opinion that you should get familiar with this operating system.
+Maybe you could start with the very easy-to-use \ubuntu\ \linux~\cite{CN2020ULB}.
+Either way, in the following, I will try to provide examples and instructions for both \ubuntu\ and the commercial Microsoft \windows~\cite{B2023W1IO} \pgls{OS}.
 %
 \hinput{installingPython}{installingPython}%
 \hinput{installingPyCharm}{installingPyCharm}%

text/main/basics/gettingStarted/gettingStarted.tex

@@ -3,8 +3,8 @@
 %
 Just having a programming language and the corresponding interpreter on your system is not enough.
 Are you going to write programs in a simple text editor like a caveperson?
-No, of course not, you need an \gls{IDE}, a program which allows you to do multiple of the necessary tasks involved in the software development process under one convenient user interface.
-For this course, we recommend using \pycharm, whose community edition is freely available.
+No, of course not, you need an \pgls{IDE}, a program which allows you to do multiple of the necessary tasks involved in the software development process under one convenient user interface.
+For this course, I recommend using \pycharm, whose community edition is freely available.
 The installation guide for \pycharm\ can be found at \url{https://www.jetbrains.com/help/pycharm/installation-guide.html}.%
 %
 \hinput{installingPyCharmWindows}{installingPyCharmWindows}%

text/main/basics/gettingStarted/installingPyCharm/installingPyCharm.tex

@@ -4,7 +4,7 @@
 \centering%
 %
 \subfloat[][%
-Installing \pycharm\ using the snap install command in a \gls{terminal} opened with \ubuntuTerminal.%
+Installing \pycharm\ using the snap install command in a \pgls{terminal} opened with \ubuntuTerminal.%
 \label{fig:installingPyCharmUbuntu01snapInstall}%
 ]{\includegraphics[width=0.7\linewidth]{\currentDir/installingPyCharmUbuntu01snapInstall}}%
 %
@@ -63,9 +63,9 @@
 %
 \begin{sloppypar}%
 Installing \pycharm\ under \ubuntu\ \linux\ is very easy, as illustrated in \cref{fig:installingPyCharmUbuntu}.
-First, you open a \gls{terminal} by pressing \ubuntuTerminal.
+First, you open a \pgls{terminal} by pressing \ubuntuTerminal.
 Then, enter the command \bashil{sudo snap install pycharm-community --classic} and hit return~(\cref{fig:installingPyCharmUbuntu01snapInstall}).
-This installs the \pycharm\ software package and the necessary super user privileges are obtained via the pre-pended \gls{sudo}, which will ask us to enter the root password, as sketched in \cref{fig:installingPyCharmUbuntu02sudo}.
+This installs the \pycharm\ software package and the necessary super user privileges are obtained via the pre-pended \pgls{sudo}, which will ask us to enter the root password, as sketched in \cref{fig:installingPyCharmUbuntu02sudo}.
 Then, the installation process basically runs automatically.
 Once it has completed (see \cref{fig:installingPyCharmUbuntu05snapInstallFinished}), you can press the \keys{\OSwin} key and type \bashil{pycharm} in the launcher window to find \pycharm~(\cref{fig:installingPyCharmUbuntu06launcher}).
 A double-click will open \pycharm.%

text/main/basics/gettingStarted/installingPyCharm/installingPyCharmUbuntu/installingPyCharmUbuntu.tex

@@ -151,7 +151,7 @@
 As \cref{fig:installingPyCharmWindows09installation,fig:installingPyCharmWindows10installation,fig:installingPyCharmWindows11installation} show, the installation setup process is more or less automated, we just need to click \keys{Next} here and there and finally click \keys{Install}~(\cref{fig:installingPyCharmWindows12installation}).
 After the installation completes, we run \pycharm\ for the first time.
 Now we need to agree to the user agreement~(\cref{fig:installingPyCharmWindows16running}) and should probably choose that we do not with to send any information about our \pycharm\ usage out~(\cref{fig:installingPyCharmWindows17running}).
-Finally, as sketched in \cref{fig:installingPyCharmWindows18running}, we have a running and ready \pycharm\ \gls{IDE}.%
+Finally, as sketched in \cref{fig:installingPyCharmWindows18running}, we have a running and ready \pycharm\ \pgls{IDE}.%
 %
 \endhsection%
 %

text/main/basics/gettingStarted/installingPyCharm/installingPyCharmWindows/installingPyCharmWindows.tex

@@ -2,10 +2,10 @@
 \label{sec:installingPython}%
 In order to learn and use \python, we first need to install it.
 There are two major versions of \python\ out there: \python~\softwareStyle{2} and \python~\softwareStyle{3}.
-Our course focuses entirely on \python~\softwareStyle{3}.
+This course focuses entirely on \python~\softwareStyle{3}.
 We assume that you have installed \pythonWithVersion\ or newer.
-Hopefully, you could figure out how to do that by yourself -- but we will at least provide some quick guide here as well.
-Help can be found at the following resources:%
+We here provide some brief setup instructions.
+More help can be found at the following resources:%
 %
 \begin{itemize}%
 \item Python Downloads at \url{https://www.python.org/downloads/}%

text/main/basics/gettingStarted/installingPython/installingPython.tex

@@ -2,7 +2,7 @@
 %
 \begin{figure}%
 \centering%
-\subfloat[][Opening the \gls{terminal} under \windows: \windowsTerminal.]{%
+\subfloat[][Opening the \pgls{terminal} under \windows: \windowsTerminal.]{%
 \label{fig:installingPythonWindows01openTerminal}%
 \tightbox{\includegraphics[height=2.8cm]{\currentDir/installingPythonWindows01openTerminal}}%
 }%
@@ -52,13 +52,13 @@
 \end{figure}%
 %
 Example installation steps for \python\ on \windows\ (version~10) are sketched in \cref{fig:installPythonWindows}.
-First, you would open a \gls{terminal} using and \windowsTerminal, as shown in \cref{fig:installingPythonWindows01openTerminal}.
+First, you would open a \pgls{terminal} using and \windowsTerminal, as shown in \cref{fig:installingPythonWindows01openTerminal}.
 If \python\ is installed, then typing \bashil{python3 --version} in the terminal and hitting \keys{\return} would print the version of the \python\ installation.
 If it is not installed, however, then \windows\ will print a message informing you that \python\ is not yet installed and that you can reach the web installer by just typing \bashil{python3} (and hitting \keys{\return}, of course).0
 We do this in \cref{fig:installingPythonWindows03python}, which leads us to the installation screen (\cref{fig:installingPythonWindows04installGet}), where we need to press the \keys{Get} button.
 This will then download (\cref{fig:installingPythonWindows05downloading}) and install \python.
 When this process is completed, the screen just shows nothing (\cref{fig:installingPythonWindows06finished}).
-If we go back to the \gls{terminal} and again try \bashil{python3 --version}, it will now work and print the version of our \python\ installation.
+If we go back to the \pgls{terminal} and again try \bashil{python3 --version}, it will now work and print the version of our \python\ installation.
 In our case, this is version~\softwareStyle{3.12}.%
 %
 \endhsection%

text/main/basics/gettingStarted/installingPython/installingPythonWindows/installingPythonWindows.tex

@@ -3,13 +3,13 @@
 \begin{figure}%
 \centering%
 \includegraphics[width=0.7\linewidth]{\currentDir/ubuntuTerminalPythonVersion}%
-\caption{Under \ubuntu\ \linux~\softwareStyle{22.04}, typing \bashil{python3 --version} in a \gls{terminal} and hitting return yields version~\softwareStyle{3.10}.}%
+\caption{Under \ubuntu\ \linux~\softwareStyle{22.04}, typing \bashil{python3 --version} in a \pgls{terminal} and hitting return yields version~\softwareStyle{3.10}.}%
 \label{fig:ubuntuTerminalPythonVersion}%
 \end{figure}%
 %
 \begin{sloppypar}%
 Under \ubuntu\ \linux, \python~\softwareStyle{3} is already pre-installed.
-You can open a \gls{terminal}, type \bashil{python3 --version}, hit \keys{\return}, and get the result illustrated in \cref{fig:ubuntuTerminalPythonVersion}:%
+You can open a \pgls{terminal}, type \bashil{python3 --version}, hit \keys{\return}, and get the result illustrated in \cref{fig:ubuntuTerminalPythonVersion}:
 My system has \python\ version~\softwareStyle{3.10} installed.%
 \end{sloppypar}%
 %