included software versions

Author: thomasWeise

scripts/dependencyVersions.sh

@@ -0,0 +1,23 @@
+#!/bin/bash -
+
+# This script prints the versions of the dependencies and software environment under which the book was built.
+
+# strict error handling
+set -o pipefail  # trace ERR through pipes
+set -o errtrace  # trace ERR through 'time command' and other functions
+set -o nounset   # set -u : exit the script if you try to use an uninitialized variable
+set -o errexit   # set -e : exit the script if any statement returns a non-true return value
+
+# get the script directory
+scriptDir="$(dirname "$0")"
+
+# Print the python version.
+echo "python: $(python3 --version | sed -n 's/.*Python\s*\([.0-9]*\)/\1/p')"
+echo "latexgit_py: $(pip freeze | grep latexgit | sed -n 's/.*==*\([.0-9]*\)/\1/p')"
+echo "latexgit_tex: $(less $scriptDir/../styles/latexgit.sty | sed -n 's/.*\\ProvidesPackage{latexgit}\[[0-9\/]* *\([.0-9]*\) .*\].*/\1/p')"
+echo "pycommons: $(pip freeze | grep pycommons | sed -n 's/.*==*\([.0-9]*\)/\1/p')"
+echo "pdflatex: $(pdflatex --version | grep 'pdfTeX 3')"
+echo "biber: $(biber --version | sed -n 's/.*:\s*\([.0-9]*\)/\1/p')"
+echo "makeglossaries: $(makeglossaries --version | grep Version | sed -n 's/.*Version\s*\([.0-9]*\)/\1/p')"
+echo "makeindex: $(echo '' | makeindex  2>&1 | grep makeindex | sed -n 's/.*version\s*\([.0-9]*\)/\1/p')"
+echo "ghostscript: $(ghostscript --version)"

styles/listing.sty

@@ -24,11 +24,11 @@ basicstyle=\@lstbasicstyle,%
 identifierstyle=\color{listing-identifier},%
 numberstyle=\color{listing-line-numbers},%
 %
-otherkeywords={\%,\},\{,\&,\|},
-keywordstyle=\color{listing-keyword-1}\bfseries,
+otherkeywords={\%,\},\{,\&,\|},%
+keywordstyle=\color{listing-keyword-1}\bfseries,%
 %
 emph={and,break,class,continue,def,yield,del,elif,else,except,exec,finally,for,from,global,if,import,in,lambda,not,or,pass,print,raise,return,try,while,assert,with},%
-emphstyle=\color{listing-emph-1}\bfseries,
+emphstyle=\color{listing-emph-1}\bfseries,%
 %
 emph={[2]True,False,None},%
 emphstyle=[2]\color{listing-emph-2},%
@@ -78,6 +78,49 @@ literate=%
 }%
 \lstset{style=python_style}%
 %
+%
+\lstdefinestyle{text_style}{%
+%
+backgroundcolor=\color{listing-background},%
+numbers=left,%
+frame=single,%
+rulecolor=\color{listing-rule},%
+frameround=ffff,%
+%
+breaklines=true,%
+tabsize=4,%
+%
+language={},%
+sensitive=true,%
+%
+basicstyle=\@lstbasicstyle,%
+numberstyle=\@lstbasicstyle,%
+identifierstyle=\@lstbasicstyle,%
+numberstyle=\@lstbasicstyle,%
+keywordstyle=\@lstbasicstyle,%
+emphstyle=\@lstbasicstyle,%
+commentstyle=\@lstbasicstyle,%
+stringstyle=\@lstbasicstyle,%
+%
+literate=%
+{á}{{\'a}}1 {é}{{\'e}}1 {í}{{\'i}}1 {ó}{{\'o}}1 {ú}{{\'u}}1%
+{Á}{{\'A}}1 {É}{{\'E}}1 {Í}{{\'I}}1 {Ó}{{\'O}}1 {Ú}{{\'U}}1%
+{à}{{\`a}}1 {è}{{\'e}}1 {ì}{{\`i}}1 {ò}{{\`o}}1 {ù}{{\`u}}1%
+{À}{{\`A}}1 {È}{{\'E}}1 {Ì}{{\`I}}1 {Ò}{{\`O}}1 {Ù}{{\`U}}1%
+{ä}{{\"a}}1 {ë}{{\"e}}1 {ï}{{\"i}}1 {ö}{{\"o}}1 {ü}{{\"u}}1%
+{Ä}{{\"A}}1 {Ë}{{\"E}}1 {Ï}{{\"I}}1 {Ö}{{\"O}}1 {Ü}{{\"U}}1%
+{â}{{\^a}}1 {ê}{{\^e}}1 {î}{{\^i}}1 {ô}{{\^o}}1 {û}{{\^u}}1%
+{Â}{{\^A}}1 {Ê}{{\^E}}1 {Î}{{\^I}}1 {Ô}{{\^O}}1 {Û}{{\^U}}1%
+{œ}{{\oe}}1 {Œ}{{\OE}}1 {æ}{{\ae}}1 {Æ}{{\AE}}1 {ß}{{\ss}}1%
+{ç}{{\c c}}1 {Ç}{{\c C}}1 {ø}{{\o}}1 {å}{{\r a}}1 {Å}{{\r A}}1%
+{€}{{\EUR}}1 {£}{{\pounds}}1 {«}{{\guillemotleft}}1%
+{»}{{\guillemotright}}1 {ñ}{{\~n}}1 {Ñ}{{\~N}}1 {¿}{{?`}}1%
+{…}{{\ldots}}1 {≥}{{>=}}1 {≤}{{<=}}1 {„}{{\glqq}}1 {“}{{\grqq}}1%
+{”}{{''}}1%
+}%
+%
+%
+%
 %% the box around the inline listings
 \protected\gdef\inlinelistingbox#1{\bgroup%
 \fboxsep=0.5pt%
@@ -103,7 +146,7 @@ literate=%
 %% print some Python code inline with an 's' added for plural
 %% #1 the optional args
 %% #2 the code to be printed inline
-\gdef\pythons#1{%
+\gdef\pythonils#1{%
 \inlinelistingbox{\lstinline[style=python_style]$#1$\resizebox{!}{\@lstbasicstylesheight}{\color{darkgray}s}}}%
 %
 %%
@@ -138,3 +181,15 @@ literate=%
 \protected\gdef\relCode#1#2#3{%
 \lstinputlisting[float,label={lst:#2},caption={#3}]{\currentDir/#1}}%
 %
+%%
+%% Use latexgit to place a listing with program output.
+%% #1 the git repository
+%% #2 the local path
+%% #3 the command
+%% #4 the label (exec: will be pre-pended)
+%% #5 the caption
+\protected\gdef\gitOutput#1#2#3#4#5{%
+\gitExec{#1}{#2}{#3}%
+\lstinputlisting[float,style=text_style,label={exec:#4},caption={#5}]{\gitFile}%
+}%
+%

text/front/preface/preface.tex

@@ -10,3 +10,6 @@ \chapter*{Preface}%
 You can freely share it.
 Please do not print it, though, to preserve the environment.
 
+This book was built using the software versions given in \cref{exec:versions}.
+
+\gitOutput{}{}{scripts/dependencyVersions.sh}{versions}{The versions of the software packages used to build this book.}

text/main/basics/simpleDataTypesAndOperations/float/float.tex

@@ -28,7 +28,7 @@
 But how does it work in \python?
 How can we deal with the fact that we cannot dynamically represent fractional numbers exactly even in typical everyday cases?
 With \pythonilIdx{float}, \python\ offers us one type for fractional numbers.
-This datatype represents numbers usually in the same internal structure as \pythonil{double}s in the \pgls{C}~programming language~\cite{PSF2024NTIFC}, which, in turn, internally have a 64~bit IEEE~Standard 754 floating point number layout~\cite{IEEE2019ISFFPA,H1997IS7FPN}.
+This datatype represents numbers usually in the same internal structure as \pythonils{double} in the \pgls{C}~programming language~\cite{PSF2024NTIFC}, which, in turn, internally have a 64~bit IEEE~Standard 754 floating point number layout~\cite{IEEE2019ISFFPA,H1997IS7FPN}.
 The idea behind this standard is to represent both very large numbers, like~$10^{300}$ and very small numbers, like~$10^{-300}$.
 In order to achieve this, the 64~bits are divided into three pieces, as illustrated in \cref{fig:floatIEEEStructure}.
 %

text/main/basics/simpleDataTypesAndOperations/str/str.tex

@@ -456,7 +456,7 @@
 They are basically lists of characters.
 We can index them, i.e., extract portions of text, we can search inside a string to check whether and where it contains a certain substring, and we can manipulate strings, e.g., by replacing substrings.
 
-It is also important that we can transform data such as \pythonil{int}s, \pythonil{float}s, or \pythonil{bool}s to strings.
+It is also important that we can transform data such as \pythonils{int}, \pythonils{float}, or \pythonils{bool} to strings.
 Because we actually \emph{always} print them as strings to the console.
 The user cannot interpret the binary representation of such data, they only want text.
 While the function \pythonil{str} can convert many different types of objects to strings, we often want to combine several different pieces of information to an output text.