Add generic localSettings.yaml as reference

README.md

@@ -1,6 +1,6 @@
 # ba-letter
 
-Repository containing the latex source for the bachelor's thesis letter.
+Repository containing latex source for the Bachelor's Thesis paper.
 
 After cloning, make sure to initialize the submodules containing the dependencies:
 ```bash
@@ -11,24 +11,17 @@ $ git submodule update --init
 
 ### Build on host
 
-For a list of dependencies consult one of the dockerfiles in the `dockerfiles` directory. Build document:
-
 ```bash
 $ make
 ```
 
-After compiling, the PDF can be found in the `build` directory.
-
 ### Build using docker
 
-Be warned that `texlive` installations can take some time.
-Building the docker image may take a few minutes.
-
 1. Build docker image
     ```bash
     $ docker build -f dockerfiles/Dockerfile.alpine . -t ba-letter
     ```
-2. Build document
+2. Build examples
     ```bash
     $ docker run --rm -v $PWD:$PWD -w $PWD -u `id -u`:`id -g` ba-letter make
     ```

dockerfiles/Dockerfile.alpine

@@ -2,13 +2,6 @@ FROM alpine:3.19
 
 RUN apk update && apk upgrade
 RUN apk add make texlive texmf-dist-pictures
-RUN apk add texmf-dist-publishers texmf-dist-science texmf-dist-fontsextra texmf-dist-latexextra
+RUN apk add texmf-dist-publishers
-RUN apk add biber texmf-dist-bibtexextra
+RUN apk add texmf-dist-science
-
+RUN apk add texmf-dist-fontsextra
-# The 'bbm' package insists on generating stuff in the home directory. In
-# order to guarantee access to the home directory no matter the user the
-# docker container is run with, create a temporary one anyone can write to
-RUN mkdir /tmp/home
-RUN chmod -R 777 /tmp/home
-ENV HOME=/tmp/home
-

dockerfiles/Dockerfile.arch

@@ -1,25 +0,0 @@
-FROM archlinux:latest
-
-RUN pacman-key --init
-RUN pacman-key --populate archlinux
-RUN pacman -Sy archlinux-keyring --noconfirm && pacman -Su --noconfirm
-
-RUN pacman -Syu --noconfirm
-RUN pacman -S make perl texlive texlive-binextra texlive-pictures --noconfirm
-RUN pacman -S texlive-publishers texlive-mathscience texlive-fontsextra texlive-latexextra --noconfirm
-RUN pacman -Syu biber texlive-bibtexextra --noconfirm
-
-# The 'bbm' package insists on generating stuff in the home directory. In
-# order to guarantee access to the home directory no matter the user the
-# docker container is run with, create a temporary one anyone can write to
-RUN mkdir /tmp/home
-RUN chmod -R 777 /tmp/home
-ENV HOME=/tmp/home
-
-# Generate font necessary for \mathbbm{1}
-RUN mktexpk --mfmode / --bdpi 600 --mag 1+0/600 --dpi 600 bbm10
-RUN chmod -R 777 /tmp/home
-
-# For some reason simply installing 'biber' does not set the path
-ENV PATH="${PATH}:/usr/bin/vendor_perl"
-

dockerfiles/Dockerfile.archlinux

@@ -0,0 +1,9 @@
+FROM archlinux:latest
+
+RUN pacman-key --init
+RUN pacman-key --populate archlinux
+RUN pacman -Sy archlinux-keyring --noconfirm && pacman -Su --noconfirm
+
+RUN pacman -Syu --noconfirm
+RUN pacman -S make perl texlive texlive-binextra texlive-pictures --noconfirm
+RUN pacman -S texlive-publishers texlive-mathscience texlive-fontsextra --noconfirm

dockerfiles/Dockerfile.ubuntu

@@ -4,13 +4,4 @@ ARG DEBIAN_FRONTEND=noninteractive
 
 RUN apt update -y && apt upgrade -y
 RUN apt install make texlive latexmk texlive-pictures -y
-RUN apt install texlive-publishers texlive-science texlive-fonts-extra texlive-latex-extra -y
+RUN apt install make texlive-publishers texlive-science texlive-fonts-extra -y
-RUN apt install biber texlive-bibtex-extra -y
-
-# The 'bbm' package insists on generating stuff in the home directory. In
-# order to guarantee access to the home directory no matter the user the
-# docker container is run with, create a temporary one anyone can write to
-RUN mkdir /tmp/home
-RUN chmod -R 777 /tmp/home
-ENV HOME=/tmp/home
-

letter.bib

@@ -1,104 +0,0 @@
-@ARTICLE{ADMM,
-  author={Barman, Siddharth and Liu, Xishuo and Draper, Stark C. and Recht, Benjamin},
-  journal={IEEE Transactions on Information Theory}, 
-  title={Decomposition Methods for Large Scale LP Decoding}, 
-  year={2013},
-  volume={59},
-  number={12},
-  pages={7870-7886},
-%  doi={10.1109/TIT.2013.2281372}
-}
-
-@ARTICLE{feldman_paper,
-  author={Feldman, J. and Wainwright, M.J. and Karger, D.R.},
-  journal={IEEE Transactions on Information Theory}, 
-  title={Using linear programming to Decode Binary linear codes}, 
-  year={2005},
-  volume={51},
-  number={3},
-  pages={954-972},
-%  doi={10.1109/TIT.2004.842696}
-}
-
-@ARTICLE{ml_in_the_list,
-	author={Geiselhart, Marvin and Elkelesh, Ahmed and Ebada, Moustafa and Cammerer, Sebastian and Brink, Stephan ten},
-	journal={IEEE Transactions on Communications}, 
-	title={Automorphism Ensemble Decoding of Reed–Muller Codes}, 
-	year={2021},
-	volume={69},
-	number={10},
-	pages={6424-6438},
-%	doi={10.1109/TCOMM.2021.3098798}
-}
-
-@ARTICLE{mackay99,
-  author={MacKay, D.J.C.},
-  journal={IEEE Transactions on Information Theory}, 
-  title={Good error-correcting codes based on very sparse matrices}, 
-  year={1999},
-  volume={45},
-  number={2},
-  pages={399-431},
-%  doi={10.1109/18.748992}
-}
-
-@online{mackay,
-    author = {MacKay, David J.C.},
-    title  = {Encyclopedia of Sparse Graph Codes},
-    date   = {2023-04},
-    url    = {http://www.inference.org.uk/mackay/codes/data.html}
-}
-
-@article{proximal_algorithms,
-  title={Proximal algorithms},
-  author={Parikh, Neal and Boyd, Stephen and others},
-  journal={Foundations and trends{\textregistered} in Optimization},
-  volume={1},
-  number={3},
-  pages={127--239},
-  year={2014},
-  publisher={Now Publishers, Inc.}
-}
-
-@book{channel_codes_book,
-    place={Cambridge},
-    title={Channel Codes: Classical and Modern},
-%    DOI={10.1017/CBO9780511803253},
-    publisher={Cambridge University Press},
-    author={Ryan, William and Lin, Shu},
-    year={2009},
-%    url={https://d1.amobbs.com/bbs_upload782111/files_35/ourdev_604508GHLFR2.pdf}
-}
-
-@INPROCEEDINGS{adaptive_lp_decoding,
-  author={Taghavi, Mohammad H. and Siegel, Paul H.},
-  booktitle={2006 IEEE International Symposium on Information Theory}, 
-  title={Adaptive Linear Programming Decoding}, 
-  year={2006},
-  volume={},
-  number={},
-  pages={1374-1378},
-%  doi={10.1109/ISIT.2006.262071}
-}
-
-@INPROCEEDINGS{interior_point_decoding,
-  author={Vontobel, Pascal O.},
-  booktitle={2008 Information Theory and Applications Workshop}, 
-  title={Interior-point algorithms for linear-programming decoding}, 
-  year={2008},
-  volume={},
-  number={},
-  pages={433-437},
-%  doi={10.1109/ITA.2008.4601085}
-}
-
-@article{proximal_paper,
-    title={Proximal Decoding for {LDPC} Codes},
-    author={Tadashi Wadayama and Satoshi Takabe},
-    journal={IEICE Transactions on Fundamentals of Electronics, Communications and Computer Sciences},
-%    volume={advpub},
-%    pages={2022TAP0002},
-    year={2022},
-%    doi={10.1587/transfun.2022TAP0002}
-}
-

localSettings.yaml

@@ -0,0 +1,29 @@
+indentPreamble: 1
+defaultIndent: '    '
+maxNumberOfBackUps: 9
+modifyLineBreaks:
+    preserveBlankLines: 1
+    condenseMultipleBlankLinesInto: 0
+    oneSentencePerLine:
+        manipulateSentences: 1
+        removeSentenceLineBreaks: 0
+        sentencesFollow:
+            par: 1
+            blankLine: 1
+            fullStop: 1
+            exclamationMark: 1
+            questionMark: 1
+            rightBrace: 1
+            commentOnPreviousLine: 1
+            other: 0
+        sentencesBeginWith:
+            A-Z: 1
+            a-z: 0
+            other: 0
+        sentencesEndWith:
+            basicFullStop: 0
+            betterFullStop: 1
+            exclamationMark: 1
+            questionMark: 1
+            other: '(?:\.\)(?!\h*[a-z]))|(?:(?<!(?:(?:e\.g)|(?:i\.e)|(?:etc))))\.(?!(?:[a-z]|[A-Z]|\-|\,|\.|[0-9]))'
+