some more text about packages and virtual environments

Author: thomasWeise

bibliography/bibliography.bib

@@ -127,6 +127,7 @@ @string { a_feldt_robert
 @string { a_feng_yu = "Yu Feng" }
 @string { a_fernandez_del_rio_jaime = "Jaime {Fern{\'a}ndez del R{\'i}o}" }
 @string { a_ferraiolo_jon = "Jon Ferraiolo" }
+@string { a_figgins_stephen = "Stephen Figgins" }
 @string { a_filaseta_michael = "Michael Filaseta" }
 @string { a_finucane_stephen = "Stephen Finucane" }
 @string { a_fitzpatrick_richard = "Richard Fitzpatrick" }
@@ -243,6 +244,7 @@ @string { a_lima_luan_p
 @string { a_lin_zeming = "Zeming Lin" }
 @string { a_liu_yuxi = "Yuxi Liu" }
 @string { a_lotha_gloria = "Gloria Lotha" }
+@string { a_love_robert = "Robert Love" }
 @string { a_lownds_tony = "Tony Lownds" }
 @string { a_loy_marc = "Marc Loy" }
 @string { a_luce_laurent = "Laurent Luce" }
@@ -261,6 +263,7 @@ @string { a_mcintosh_shane
 @string { a_mdn_contributors = "{{MDN}~Contributors}" }
 @string { a_mejia_alvarez_pedro = "Pedro {Mejia Alvarez}" }
 @string { a_mendoza_mark = "Mark Mendoza" }
+@string { a_meyer_carl = "Carl Meyer" }
 @string { a_michel_vincent = "Vincent Michel" }
 @string { a_mikkonen_tommi = "Tommi Mikkonen" }
 @string { a_millman_jarrod_k = "K.\ Jarrod Millman" }
@@ -309,6 +312,7 @@ @string { a_peterson_pearu
 @string { a_pfeiffer_silvia = "Silvia Pfeiffer" }
 @string { a_phalgun_amit = "Amit Phalgun" }
 @string { a_picus_matti = "Matti Picus" }
+@string { a_pip_developers = "\pip\ developers" }
 @string { a_polat_ilhan = "Ilhan Polat" }
 @string { a_pollard_tom_j = "Tom J.\ Pollard" }
 @string { a_pomerance_carl = "Carl Pomerance" }
@@ -325,6 +329,7 @@ @string { a_ribeiro_antonio_h
 @string { a_riesel_hans = "Hans Riesel" }
 @string { a_ritter_frank_e = "Frank E. Ritter" }
 @string { a_rivest_ronald_linn = "Ronald Linn Rivest" }
+@string { a_robbins_arnold = "Arnold Robbins" }
 @string { a_robertson_edmund_f = "Edmund F.\ Robertson" }
 @string { a_robson_eleanor = "Eleanor Robson" }
 @string { a_rocha_linoln_s = "Lincoln S.\ Rocha" }
@@ -360,6 +365,7 @@ @string { a_shen_kangshen
 @string { a_sheppart_kevin = "Kevin Sheppard" }
 @string { a_shewchuk_jonathan_richard = "Jonathan Richard Shewchuk" }
 @string { a_shimizukawa_takayuki = "Takayuki Shimizukawa" }
+@string { a_siever_ellen = "Ellen Siever" }
 @string { a_sigler_laurence_e = "Laurence E.\ Sigler" }
 @string { a_silberschatz_avi = "Avi Silberschatz" }
 @string { a_silva_sara = "Sara Silva" }
@@ -401,6 +407,7 @@ @string { a_van_kerkwijk_marten_h
 @string { a_van_mulbregt_paul = "Paul {van Mulbregt}" }
 @string { a_van_rossum_guido = "Guido {van Rossum}" }
 @string { a_van_rysdam = "Peter {van Rysdam}" }
+@string { a_van_vugt_sander = "Sander {van Vugt}" }
 @string { a_varoquaux_gael = "Ga{\"e}l Varoquaux" }
 @string { a_varro_daniel = "D{\'a}niel Varr{\'o}" }
 @string { a_vasilescu_bogdan = "Bogdan Vasilescu" }
@@ -588,6 +595,7 @@ @string { p_packt
 @string { p_payhip = "{Payhip}" }
 @string { p_pearson_education = "{Pearson Education,~Inc.}" }
 @string { p_microsoft_press = "{Microsoft Press}, " # p_pearson_education }
+@string { p_pearson_it_certification = "{Pearson {IT} Certification}" }
 @string { p_plos = "{Public Library of Science~{(PLOS)}}" }
 @string { p_pragmatic_ai_labs = "{Pragmatic {AI} Labs}" }
 @string { p_pragmatic_bookshelf = "{{Pragmatic Bookshelf} {by} {The Pragmatic Programmers, {L.L.C.}}}" }
@@ -681,6 +689,7 @@ @string { pa_packt
 @string { pa_payhip = l_uk_london }
 @string { pa_pearson_education = l_usa_hoboken }
 @string { pa_microsoft_press = pa_pearson_education }
+@string { pa_pearson_it_certification = pa_pearson_education }
 @string { pa_plos = l_usa_san_francisco }
 @string { pa_pragmatic_ai_labs = l_usa_san_francisco }
 @string { pa_pragmatic_bookshelf = l_usa_flower_mound }
@@ -1406,9 +1415,9 @@ @book{CLRS2009ITA
 }
 
 @book{CN2020ULB,
+ author = a_clinton_david # and # a_negus_christopher,
  title = {\ubuntu\ \linux\ Bible},
  edition = {10},
- author = a_clinton_david # and # a_negus_christopher,
  date = {2020-11-10},
  isbn = {978-1119722335},
  xdata = {ser_bs},
@@ -2309,6 +2318,23 @@ @book{PC2024PL
  urldate = {2024-09-24}
 }
 
+@book{PD2024PD,
+ title = {\pip\ Documentation~v24.3.1},
+ author = a_pip_developers,
+ date = {2024-10-27},
+ publisher = p_python_software_foundation,
+ address = pa_python_software_foundation,
+ url = {https://pip.pypa.io},
+ urldate = {2024-12-25},
+}
+
+@inbook{PD2024RFF,
+ title = {Requirements File Format},
+ crossref = {PD2024PD},
+ url = {https://pip.pypa.io/en/stable/reference/requirements-file-format},
+ urldate = {2024-12-25},
+}
+
 @techreport{PEP8,
  title = {Style Guide for \python\ Code},
  author = a_van_rossum_guido # and # a_warsaw_barry # and # a_coghlan_alyssa,
@@ -2418,6 +2444,16 @@ @techreport{PEP362
  urldate = {2024-12-12},
 }
 
+@techreport{PEP405,
+ author = a_meyer_carl,
+ title = {\python\ \glslink{virtualEnvironment}{Virtual Environments}},
+ number = {405},
+ xdata = {rep_pep},
+ date = {2011-06-13/2012-05-24},
+ url = {https://peps.python.org/pep-0405},
+ urldate = {2024-12-25},
+}
+
 @techreport{PEP482,
  author = a_langa_lukasz,
  title = {Literature Overview for \glslink{typeHint}{Type Hints}},
@@ -2955,6 +2991,21 @@ @inbook{PSF2024TWS
  urldate = {2024-12-15},
 }
 
+@inbook{PSF2024VCOVE,
+ title = {\pythonilIdx{venv} -- Creation of \glslink{virtualEnvironment}{Virtual Environments}},
+ xdata = {PSF2024TPSL},
+ url = {https://docs.python.org/3/library/venv.html},
+ urldate = {2024-12-25},
+}
+
+@inbook{PSF2024VEAP,
+ title = {Virtual Environments and Packages},
+ chapter = {12},
+ xdata = {PSF2024TPT},
+ url = {https://docs.python.org/3/tutorial/venv.html},
+ urldate = {2024-12-24},
+}
+
 @xdata{PSF2024WNIP,
  volume = {What's New in \python},
  crossref = {PSF2024P3D}
@@ -3184,14 +3235,6 @@ @inbook{SD2024DCAD
  urldate = {2024-12-12},
 }
 
-@book{SD2024SIDFD,
- author = a_sphinx_developers,
- title = {\pythonilIdx{sphinx.ext.autodoc} -- Include Documentation from \pglspl{docstring}},
- date = {2024-10-13},
- url = {https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html},
- urldate = {2024-12-12},
-}
-
 @book{SCL1999TNCOTMACAC,
  title = {The Nine Chapters on the Mathematical Art:~{C}ompanion and Commentary},
  author = a_shen_kangshen # and # a_crossley_john_newsome # and # a_lun_anthony_w_c,
@@ -3202,6 +3245,14 @@ @book{SCL1999TNCOTMACAC
  address = pa_oxford_university_press
 }
 
+@book{SD2024SIDFD,
+ author = a_sphinx_developers,
+ title = {\pythonilIdx{sphinx.ext.autodoc} -- Include Documentation from \pglspl{docstring}},
+ date = {2024-10-13},
+ url = {https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html},
+ urldate = {2024-12-12},
+}
+
 @article{SF2013ASROSR,
  author = a_shahrokni_ali # and # a_feldt_robert,
  title = {A Systematic Review of Software Robustness},
@@ -3215,6 +3266,16 @@ @article{SF2013ASROSR
  urldate = {2024-10-29},
 }
 
+@book{SFLR2009LIAN,
+ author = a_siever_ellen # and # a_figgins_stephen # and # a_love_robert # and # a_robbins_arnold,
+ title = {\linux\ in a Nutshell},
+ edition = {6},
+ date = {2009-09},
+ publisher = p_oreilly,
+ address = pa_oreilly,
+ isbn = {9780596154486},
+}
+
 @book{SKS2019DSC,
  author = a_silberschatz_avi # and # a_korth_henry_f # and # a_sudarshan_s,
  title = {Database System Concepts},
@@ -3361,6 +3422,16 @@ @techreport{VR1999CPFERPASEFTPOT
  urldate = {2024-06-27}
 }
 
+@book{VV2022LF,
+ author = a_van_vugt_sander,
+ title = {\linux\ Fundamentals},
+ edition = {2},
+ date = {2022-06},
+ isbn = {0137929315},
+ publisher = p_pearson_it_certification,
+ address = pa_pearson_it_certification
+}
+
 @inproceedings{VVH2018ELDOSAIOSPACSOTPE,
  author = a_valiev_marat # and # a_vasilescu_bogdan # and # a_herbsleb_james_d,
  title = {Ecosystem\nobreakdashes-Level Determinants of Sustained Activity in Open\nobreakdashes-Source Projects:~{A} Case Study of the \pypi\ Ecosystem},

notation/software.sty

@@ -5,13 +5,26 @@
 \protected\gdef\softwareStyle#1{\scalebox{0.95}[1]{\texttt{#1}}}%
 %
 %
+\newglossaryentry{aptGet}{%
+text={\softwareStyle{apt\nobreakdashes-get}},%
+name={apt-get},%
+sort={apt-get},%
+description={%
+\bashil{apt-get} is a command used to install Debian~\textil{deb} packages under \ubuntu\ \linux~\cite{H2022LML,SFLR2009LIAN,VV2022LF}. %
+Using \bashil{apt-get} requires superuser privileges~(\pgls{sudo}), i.e., one usually does \bashil{sudo apt-get install...}. %
+Learn more at \url{https://salsa.debian.org/apt-team/apt}.%
+}%
+}%
+\protected\gdef\aptGet{\pgls{aptGet}}%
+%
+%
 \newglossaryentry{bash}{%
 text={\softwareStyle{Bash}},%
 name={Bash},%
 sort={Bash},%
 description={%
 is a the shell used under \ubuntu\ \linux, i.e., the program that \inQuotes{runs} in the \pgls{terminal} and interprets your commands, allowing you to start and interact with other programs~\cite{NR2005LTBSUSPCB3,Z2017MB,BN2018BC}. %
-Learn more at \url{https://www.gnu.org/software/bash/}.%
+Learn more at \url{https://www.gnu.org/software/bash}.%
 }%
 }%
 \protected\gdef\bash{\pgls{bash}}%
@@ -35,10 +48,10 @@ text={\softwareStyle{Linux}},%
 name={Linux},%
 sort={Linux},%
 description={%
-is the leading open source operating system, i.e., a free alternative for \windows~\cite{T1999TLE,B2022ELATCL,H2022LML}. %
+is the leading open source operating system, i.e., a free alternative for \windows~\cite{T1999TLE,B2022ELATCL,H2022LML,SFLR2009LIAN,VV2022LF}. %
 Its variant \ubuntu\ is particularly easy to use and install. %
 We recommend using it for this course, for software development, and for research. %
-Learn more at \url{https://www.linux.org/}.%
+Learn more at \url{https://www.linux.org}.%
 }%
 }%
 \protected\gdef\linux{\pgls{linux}}%
@@ -87,7 +100,7 @@ name={NumPy},%
 sort={NumPy},%
 description={%
 is a fundamental package for scientific computing with \python, which offers efficient array datastructures~\cite{HMvdWGVCWTBSKPHvKBHFdRWPGMSRWAGO2020APWN,DBvR2024ITN,J2018NPSCADSAWNSAM}. %
-Learn more at \url{https://numpy.org/}.%
+Learn more at \url{https://numpy.org}.%
 }%
 }%
 \protected\gdef\numpy{\pgls{numpy}}%
@@ -111,7 +124,7 @@ name={pip},%
 sort={pip},%
 description={%
 \pythonIdx{pip}%
-is the standard tool to install \python\ software packages from the \pgls{pypi} repository~\cite{PSF2024IPM}. %
+is the standard tool to install \python\ software packages from the \pgls{pypi} repository~\cite{PSF2024IPM,PD2024PD}. %
 To install a package \bashil{thepackage} hosted on \pgls{pypi}, type \bashil{pip install thepackage} into the \pgls{terminal}. %
 Learn more at \url{https://packaging.python.org/installing}.%
 }%
@@ -270,6 +283,19 @@ If you are in China, you can download it from \expandafter\url{\ubuntuDownloadUr
 \xdef\ubuntuDownloadUrl{https://mirrors.ustc.edu.cn/ubuntu-releases}%
 %
 %
+\newglossaryentry{venv}{%
+text={\softwareStyle{venv}},%
+name={venv},%
+sort={venv},%
+description={%
+\pythonIdx{venv}%
+is a \python\ module and tool for creating \pglspl{virtualEnvironment}~\cite{PSF2024VCOVE}. %
+Learn more at \url{https://docs.python.org/3/library/venv.html}~\cite{PSF2024VCOVE}.%
+}%
+}%
+\protected\gdef\venv{\pgls{venv}}%
+%
+%
 \newglossaryentry{windows}{%
 text={\softwareStyle{Windows}},%
 name={Windows},%

notation/terms.sty

@@ -220,6 +220,16 @@ Modulo division is mentioned in \cref{sec:int,sec:floatarith}.%
 }%
 %
 %
+\newglossaryentry{package}{%
+name={package},%
+description={%
+A \python\ package is basically a directory containing \python\ files. %
+This allows us to group functionality together as a library that can be used by different applications. %
+Many popular \python\ packages are offered as open source at \pgls{pypi} and can be installed with~\pip, which we discuss in \cref{sec:pipAndVenv}.%
+}%
+}%
+%
+%
 \newglossaryentry{regexp}{%
 name={regular expression},%
 description={%
@@ -370,6 +380,17 @@ The most popular distributed \pgls{VCS} is \pgls{git}.%
 }%
 %
 %
+\newglossaryentry{virtualEnvironment}{%
+name={virtual environment},%
+description={%
+A virtual environment is a directory that contains a local \python\ installation~\cite{PSF2024VEAP,PEP405}. %
+It comes with its own package installation directory. %
+Multiple different virtual environments can be installed on a system. %
+This allows different applications to use different versions of the same packages without conflict, because we can simply install these applications into different \pglspl{virtualEnvironment}.%
+}%
+}%
+%
+%
 \newglossaryentry{xAxis}{%
 name={\ensuremath{x}\nobreakdashes-axis},%
 plural={\ensuremath{x}\nobreakdashes-axes},%

text/main/basics/collections/lists/lists.tex

@@ -166,7 +166,7 @@
 \begin{figure}%
 \centering%
 \includegraphics[width=0.7\linewidth]{\currentDir/pipInstallRuff}%
-\caption{Installing \ruff\ in a \ubuntu\ \pgls{terminal} via \pip.}%
+\caption{Installing \ruff\ in a \ubuntu\ \pgls{terminal} via \pip~(see \cref{sec:pipAndVenv} for a discussion of how packages can be installed).}%
 \label{fig:pipInstallRuff}%
 \end{figure}%
 %

text/main/basics/variables/typesAndTypeHints/typesAndTypeHints.tex

@@ -82,7 +82,7 @@
 \begin{figure}%
 \centering%
 \includegraphics[width=0.7\linewidth]{\currentDir/pipInstallMypy}%
-\caption{Installing \mypy\ in a \ubuntu\ \pgls{terminal} via \pip.}%
+\caption{Installing \mypy\ in a \ubuntu\ \pgls{terminal} via \pip~(see \cref{sec:pipAndVenv} for a discussion of how packages can be installed).}%
 \label{fig:pipInstallMypy}%
 \end{figure}%
 %

text/main/controlFlow/functions/functions.tex

@@ -311,7 +311,7 @@
 \begin{figure}%
 \centering%
 \includegraphics[width=0.7\linewidth]{\currentDir/pipInstallPytest}%
-\caption{Installing \pytest\ in a \ubuntu\ \pgls{terminal} via \pip.}%
+\caption{Installing \pytest\ in a \ubuntu\ \pgls{terminal} via \pip~(see \cref{sec:pipAndVenv} for a discussion of how packages can be installed).}%
 \label{fig:pipInstallPytest}%
 \end{figure}%
 %

text/main/controlFlow/loops/loops.tex

@@ -323,7 +323,7 @@
 \begin{figure}%
 \centering%
 \includegraphics[width=0.7\linewidth]{\currentDir/pipInstallPylint}%
-\caption{Installing \pylint\ in a \ubuntu\ \pgls{terminal} via \pip.}%
+\caption{Installing \pylint\ in a \ubuntu\ \pgls{terminal} via \pip~(see \cref{sec:pipAndVenv} for a discussion of how packages can be installed).}%
 \label{fig:pipInstallPylint}%
 \end{figure}%
 %