first draft

Author: thomasWeise

.gitignore

@@ -1,2 +1,66 @@
-# programmingWithPythonSlides
-The slides to the book "Programming with Python"
+# Programming with Python
+
+## 1. Introduction
+
+*"Programming with Python"* is both a book and a course held at [Hefei University](http://www.hfuu.edu.cn/english/) ([合肥大学](http://www.hfuu.edu.cn/)).
+We here provide all the resources of this course.
+
+The goal of the course and book is to teach undergraduate and graduate students how to program with the Python programming language.
+The resources may also be suitable to high school students or whoever else may be interested in the topic.
+Our aim is to strike a good balance between theory and practice, leaning more to the practice side.
+In particular, we try to teach programming together with some software engineering concepts.
+It is the firm opinion of the author that these two cannot be separated.
+Teaching programming alone without introducing tools such as static code analysis, unit tests, and enforcing principles such as code style and proper commenting will create bad programmers.
+So we discuss these aspects while working our way through the principles of programming.
+
+
+## 2. Resources
+The website with up-to-date information about the course is <https://thomasweise.github.io/programmingWithPython>.
+
+### 2.1. The Book
+The book itself can be downloaded as pdf at <https://thomasweise.github.io/programmingWithPython/programmingWithPython.pdf>.
+
+### 2.2. The Slides
+The slides for the course are available at <https://thomasweise.github.io/programmingWithPythonSlides> and also listed below.
+
+1. [Introduction](https://thomasweise.github.io/programmingWithPythonSlides/01_introduction.pdf)
+2. [Getting Started](https://thomasweise.github.io/programmingWithPythonSlides/02_getting_started)
+
+### 2.3. The Example Python Programs 
+Our course offers a lot of examples.
+You can find all of them in the repository <https://github.com/thomasWeise/programmingWithPythonCode>.
+
+
+### 2.4. LaTeX Sources, Graphics, Bibliography, etc.
+Both the book and the slides are written in LaTeX.
+You can find their sources in <https://github.com/thomasWeise/programmingWithPython> and <https://github.com/thomasWeise/programmingWithPythonSlides>, respectively.
+You may use these files under the licensing terms provided below.
+
+
+## 3. License
+All the course material is freely available.
+You can download its newest version from <https://thomasweise.github.io/programmingWithPython>.
+This version may change since this course and book both are work in progress.
+You can freely share this.
+You can also copy text or figures under the license given below, as long as you cite the book as the original source, e.g., by using the following BibTeX:
+
+<pre>@book{programmingWithPython,<br/>&nbsp;author&nbsp;=&nbsp;{<a href="http://iao.hfuu.edu.cn/5">Thomas&nbsp;Weise</a>},<br/>&nbsp;title&nbsp;=&nbsp;{Programming&nbsp;with&nbsp;Python},<br/>&nbsp;year&nbsp;=&nbsp;{2024},<br/>&nbsp;publisher&nbsp;=&nbsp;{<a href="http://iao.hfuu.edu.cn">Institute&nbsp;of&nbsp;Applied&nbsp;Optimization</a>,<br/>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="http://www.hfuu.edu.cn/aibd">School&nbsp;of&nbsp;Artificial&nbsp;Intelligence&nbsp;and&nbsp;Big&nbsp;Data</a>,<br/>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="http://www.hfuu.edu.cn/">Hefei&nbsp;University</a>},<br/>&nbsp;address&nbsp;=&nbsp;{Hefei,&nbsp;Anhui,&nbsp;China},<br/>&nbsp;url&nbsp;=&nbsp;{<a href="https://thomasweise.github.io/programmingWithPython">https://thomasweise.github.io/programmingWithPython</a>}<br/>}</pre>
+
+**If you have any comments or suggestions regarding the book, or if you spotted an error or typo, please feel free to submit an [issue here](https://github.com/thomasWeise/programmingWithPython/issues).**
+Your feedback would help us to improve the book.
+
+This book is released under the Attribution-NonCommercial-ShareAlike 4.0 International license (CC&nbsp;BY&#8209;NC&#8209;SA&nbsp;4.0), see [http://creativecommons.org/licenses/by-nc-sa/4.0/](http://creativecommons.org/licenses/by-nc-sa/4.0/) for a summary.
+
+We statically include the [pdfsizeopt](https://github.com/pts/pdfsizeopt) tool in the [GitHub Repository](https://github.com/thomasWeise/programmingWithPython) of our book and use it during the book compiling and building process to compress the book pdf file.
+This tool is excluded from the license mentioned above.
+It is under the GNU GENERAL PUBLIC LICENSE Version 2, June 1991 and the copyright belongs to its authors.
+
+
+## 4. Contact
+If you have any questions or suggestions, please contact
+Prof. Dr. [Thomas Weise](http://iao.hfuu.edu.cn/5) (汤卫思教授)
+at the Institute of Applied Optimization (应用优化研究所, [IAO](http://iao.hfuu.edu.cn))
+of the School of Artificial Intelligence and Big Data ([人工智能与大数据学院](http://www.hfuu.edu.cn/aibd))
+of [Hefei University](http://www.hfuu.edu.cn/english/) ([合肥大学](http://www.hfuu.edu.cn/)),
+in Hefei, Anhui, China (中国安徽省合肥市)
+via email to [tweise@hfuu.edu.cn](mailto:tweise@hfuu.edu.cn) with CC to [tweise@ustc.edu.cn](mailto:tweise@ustc.edu.cn).

LICENSE.md

@@ -0,0 +1,85 @@
+#!/bin/bash
+
+# Make the slides.
+
+# 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
+
+echo "$(date +'%0Y-%0m-%0d %0R:%0S'): Welcome to the book building script."
+
+currentDir="$(pwd)"
+echo "$(date +'%0Y-%0m-%0d %0R:%0S'): We are working in directory: '$currentDir'."
+scriptDir="$currentDir/shared/scripts"
+echo "$(date +'%0Y-%0m-%0d %0R:%0S'): The script directory is '$scriptDir'."
+
+echo "$(date +'%0Y-%0m-%0d %0R:%0S'): We delete all left over data."
+websiteDir="$currentDir/website"
+rm -rf "$websiteDir" || true
+mkdir -p "$websiteDir"
+
+echo "$(date +'%0Y-%0m-%0d %0R:%0S'): We setup a virtual environment in a temp directory."
+venvDir="$(mktemp -d)"
+echo "$(date +'%0Y-%0m-%0d %0R:%0S'): Got temp dir '$venvDir', now creating environment in it."
+python3 -m venv --upgrade-deps --copies "$venvDir"
+echo "$(date +'%0Y-%0m-%0d %0R:%0S'): Activating virtual environment in '$venvDir'."
+source "$venvDir/bin/activate"
+export PYTHON_INTERPRETER="$venvDir/bin/python3"
+echo "$(date +'%0Y-%0m-%0d %0R:%0S'): Setting python interpreter to '$PYTHON_INTERPRETER'."
+echo "$(date +'%0Y-%0m-%0d %0R:%0S'): We install all required Python packages from requirements.txt to virtual environment in '$venvDir'."
+"$PYTHON_INTERPRETER" -m pip install --no-input --timeout 360 --retries 100 -r requirements.txt
+echo "$(date +'%0Y-%0m-%0d %0R:%0S'): Finished installing the requirements, now printing all installed packages."
+pip freeze
+echo "$(date +'%0Y-%0m-%0d %0R:%0S'): Finished printing all installed packages."
+
+echo "$(date +'%0Y-%0m-%0d %0R:%0S'): We now build the slides."
+
+slidesDir="$currentDir/slides"
+lastLatexGit=""
+for dirName in "$slidesDir/"*; do
+    dirName="$(basename "$dirName")"
+    theDir="$slidesDir/$dirName"
+    if [ -d "$theDir" ]; then        
+        docName="$dirName.tex"
+        if [ -f "$theDir/$docName" ]; then
+            echo "$(date +'%0Y-%0m-%0d %0R:%0S'): Found directory '$theDir' with document '$docName'."
+            
+            curDirGit="$theDir/__git__"
+            rm -rf "$curDirGit"
+            if [ -n "$lastLatexGit" ]; then
+                mv "$lastLatexGit" "$theDir"
+                lastLatexGit=""
+            fi
+            
+            cd "$theDir"
+            "$scriptDir/pdflatex.sh" "$docName"
+            "$scriptDir/pdfsizeopt.sh" "$dirName.pdf" "$websiteDir/$dirName.pdf"
+            rm "$dirName.pdf"
+            
+            if [ -d "$curDirGit" ]; then
+                echo "$(date +'%0Y-%0m-%0d %0R:%0S'): Git directory is $curDirGit."
+                lastLatexGit="$(realpath "$curDirGit")"
+                echo "$(date +'%0Y-%0m-%0d %0R:%0S'): Canonicalized git directory is $lastLatexGit."
+            fi
+            cd "$currentDir"
+        else
+            echo "$(date +'%0Y-%0m-%0d %0R:%0S'): Found directory '$theDir', but it does not contain a corresponding LaTeX document."
+        fi
+    fi
+done
+
+if [ -d "$lastLatexGit" ]; then
+    echo "$(date +'%0Y-%0m-%0d %0R:%0S'): Cleaning up '$lastLatexGit'."
+    rm -rf "$lastLatexGit"
+fi
+
+"$scriptDir/website.sh" "$websiteDir"
+
+echo "$(date +'%0Y-%0m-%0d %0R:%0S'): Deactivating virtual environment."
+deactivate
+echo "$(date +'%0Y-%0m-%0d %0R:%0S'): Deleting virtual environment."
+rm -rf "$venvDir"
+
+echo "$(date +'%0Y-%0m-%0d %0R:%0S'): We have finished the slides building process."

README.md

@@ -0,0 +1,18 @@
+#
+# Dependencies Required to Build the Optimization Algorithms Book
+#
+
+# Basically, we only need the `latexgit` Python companion package.
+# You can find it at https://thomasweise.github.io/latexgit_py,
+# https://github.com/thomasWeise/latexgit_py, or at
+# https://pypi.org/project/latexgit.
+latexgit == 0.8.25
+
+# minify_html is needed to minify html output.
+minify_html == 0.15.0
+
+# for converting the additional markdown files to HTML
+markdown == 3.7
+
+# for converting files to HTML
+Pygments == 2.18.0