Merge pull request #73 from MeierTobias/final_changes

Final changes

.gitattributes

@@ -1,2 +1,4 @@
 *.zip filter=lfs diff=lfs merge=lfs -text
 *.pdf filter=lfs diff=lfs merge=lfs -text
+*.png filter=lfs diff=lfs merge=lfs -text
+*.jpg filter=lfs diff=lfs merge=lfs -text

.github/workflows/build.yml

@@ -7,30 +7,19 @@ jobs:
  runs-on: ubuntu-latest
  steps:
  - uses: actions/checkout@v3
- - name: build latex pdf (portrait/with examples)
- uses: docker://texlive/texlive:latest
- with:
- args: latexmk -pdf -cd -interaction=nonstopmode -file-line-error -jobname=analysis_III_full_portrait -outdir=../build ./src/main.tex
- - name: change flags
- run: sed '0,/{1}/s//{0}/' -i src/headers/flags.tex ;
- - name: build latex pdf (landscape/with examples)
- uses: docker://texlive/texlive:latest
  with:
- args: latexmk -pdf -cd -interaction=nonstopmode -file-line-error -jobname=analysis_III_full_landscape -outdir=../build ./src/main.tex
- - name: change flags
- run: sed '0,/{1}/s//{0}/' -i src/headers/flags.tex ;
- - name: build latex pdf (landscape/without examples)
+ submodules: recursive
+ lfs: true
+ - name: build latex pdf (with examples)
  uses: docker://texlive/texlive:latest
  with:
- args: latexmk -pdf -cd -interaction=nonstopmode -file-line-error -jobname=analysis_III_landscape -outdir=../build ./src/main.tex
+ args: latexmk -pdf -cd -interaction=nonstopmode -file-line-error -jobname=analysis_III_full -outdir=../build ./src/main.tex
  - name: change flags
- run: sed '0,/{0}/s//{1}/' -i src/headers/flags.tex ;
- - name: build latex pdf (portrait/without examples)
+ run: sed '0,/{1}/s//{0}/' -i src/var.tex ;
+ - name: build latex pdf (without examples)
  uses: docker://texlive/texlive:latest
  with:
- args: latexmk -pdf -cd -interaction=nonstopmode -file-line-error -jobname=analysis_III_portrait -outdir=../build ./src/main.tex
- - name: change flags
- run: sed '0,/{0}/s//{1}/' -i src/headers/flags.tex ;
+ args: latexmk -pdf -cd -interaction=nonstopmode -file-line-error -jobname=analysis_III -outdir=../build ./src/main.tex
  - name: Archive pdf's as artifacts
  uses: actions/upload-artifact@v3
  with:

.github/workflows/build_deploy.yml

@@ -28,36 +28,23 @@ jobs:
  runs-on: ubuntu-latest
  steps:
  - uses: actions/checkout@v3
- - name: build latex pdf (portrait/with examples)
- uses: docker://texlive/texlive:latest
- with:
- args: latexmk -pdf -cd -interaction=nonstopmode -file-line-error -jobname=analysis_III_full_portrait -outdir=../build ./src/main.tex
- - name: change flags
- run: sed '0,/{1}/s//{0}/' -i src/headers/flags.tex ;
- - name: build latex pdf (landscape/with examples)
- uses: docker://texlive/texlive:latest
  with:
- args: latexmk -pdf -cd -interaction=nonstopmode -file-line-error -jobname=analysis_III_full_landscape -outdir=../build ./src/main.tex
- - name: change flags
- run: sed '0,/{1}/s//{0}/' -i src/headers/flags.tex ;
- - name: build latex pdf (landscape/without examples)
+ submodules: recursive
+ lfs: true
+ - name: build latex pdf (with examples)
  uses: docker://texlive/texlive:latest
  with:
- args: latexmk -pdf -cd -interaction=nonstopmode -file-line-error -jobname=analysis_III_landscape -outdir=../build ./src/main.tex
+ args: latexmk -pdf -cd -interaction=nonstopmode -file-line-error -jobname=analysis_III_full -outdir=../build ./src/main.tex
  - name: change flags
- run: sed '0,/{0}/s//{1}/' -i src/headers/flags.tex ;
- - name: build latex pdf (portrait/without examples)
+ run: sed '0,/{1}/s//{0}/' -i src/var.tex ;
+ - name: build latex pdf (without examples)
  uses: docker://texlive/texlive:latest
  with:
- args: latexmk -pdf -cd -interaction=nonstopmode -file-line-error -jobname=analysis_III_portrait -outdir=../build ./src/main.tex
- - name: change flags
- run: sed '0,/{0}/s//{1}/' -i src/headers/flags.tex ;
+ args: latexmk -pdf -cd -interaction=nonstopmode -file-line-error -jobname=analysis_III -outdir=../build ./src/main.tex
  - name: Copy output
  run: |
- cp ./build/analysis_III_full_portrait.pdf ./pages/analysis_III_full_portrait.pdf
- cp ./build/analysis_III_full_landscape.pdf ./pages/analysis_III_full_landscape.pdf
- cp ./build/analysis_III_portrait.pdf ./pages/analysis_III_portrait.pdf
- cp ./build/analysis_III_landscape.pdf ./pages/analysis_III_landscape.pdf
+ cp ./build/analysis_III_full.pdf ./pages/analysis_III_full.pdf
+ cp ./build/analysis_III.pdf ./pages/analysis_III.pdf
  - name: Setup Pages
  uses: actions/configure-pages@v3
  - name: Upload artifact

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "src/template"]
+ path = src/template
+ url = https://github.com/MeierTobias/eth-summary-template.git

README.md

@@ -7,13 +7,13 @@ It was originally created by Benno Kaeslin, Linard Furck, Sandro Christen, Marku
 
 A pre-build pdf file can be downloaded here:
 
-- [Analysis_III_full.pdf](https://meiertobias.github.io/eth-analysis-3/analysis_III_full_portrait.pdf)
-- [Analysis_III.pdf (without examples)](https://meiertobias.github.io/eth-analysis-3/analysis_III_portrait.pdf)
-- [Analysis_III_full_landscape.pdf](https://meiertobias.github.io/eth-analysis-3/analysis_III_full_landscape.pdf)
-- [Analysis_III_landscape.pdf (without examples)](https://meiertobias.github.io/eth-analysis-3/analysis_III_landscape.pdf)
+- [Analysis_III_full.pdf](https://meiertobias.github.io/eth-analysis-3/analysis_III_full.pdf)
+- [Analysis_III.pdf (without examples)](https://meiertobias.github.io/eth-analysis-3/analysis_III.pdf)
 
 ## Getting-Started
 
+To clone this repo and the necessary submodules add the `--recurse-submodules` flag to your `git clone` command. If you forgot to add the `--recurse-submodules` flag when you cloned the repo you can pull the submodules by running `git submodule init` and then `git submodule update` in the root directory of repository.
+
 After you cloned this repo there are two options to build the LaTeX files ether you [use the Docker Container](#docker-recommended) or build it with your [native installed LaTeX compile](#native-latex-compiler) of choice.
 If you want a hassle-free way to work with our LaTeX project, we recommend using Docker.
 
@@ -36,15 +36,12 @@ Specify an output directory:
 "latex-workshop.latex.outDir": "../build",
 ```
 
-Remove unnecessary build files:
+Remove unnecessary build files (slows down compilation time):
 
 ```json
 "latex-workshop.latex.clean.fileTypes" : [ "*.aux", "*.fls", "*.synctex.gz", "*.out", "*.log", "*.fdb_latexmk" ],
 "latex-workshop.latex.autoClean.run": "onBuilt",
 "latex-workshop.latex.clean.method": "glob",
-
-// if using subfolder
-"latex-workshop.latex.outDir": "../build",
 "latex-workshop.latex.clean.subfolder.enabled": true,
 ```
 
@@ -57,21 +54,23 @@ To enable the LaTeX checker ChkTeX:
 
 To get more information about the different warnings search for your warning code in the ChkTeX [documentation](https://mirror.init7.net/ctan/support/chktex/ChkTeX.pdf). If you want to disable a checker warning on a specific line you can add `% chktex ##` to the end of the line with the warning number you want to suppress.
 
-## Setup on macOS
-This repository is configured for Git [LFS](https://git-lfs.com/) (Large File Storage). If you don't already have it installed run `brew install git-lfs` or check the linked website to install it.
+## Prerequisites
 
-To use the formatter by LaTeX Workshop install `brew install latexindent`.
+The images and other compressed files are managed by git-lfs. Therefor you need to [install git-lfs](https://git-lfs.com/) fist (`brew install git-lfs` on MacOS).
+
+All LaTeX files are autoformatted with `latexindent` which comes within the TexLive installation. To install on MacOS simply run `brew install latexindent`.
 
 ## Python scripts for PDE visualization
+
 Additional Python scripts used for the visualization of various PDEs can be found in [`python_scripts/pde_plot`](python_scripts/pde_plot/). The file [`pde_plot.py`](python_scripts/pde_plot/pde_plot.py) demonstrates how to use the visualization class.
 
 ## Contributing
 
 Feel free to fork this repository and create a pull request to integrate your corrections and extensions.
 
-## Acknowledgements
+## Template
 
-Thanks to *S.* for creating this wonderful AMIV/ETHZ summaries LaTeX template which can be downloaded [here](https://de.overleaf.com/latex/templates/amiv-slash-ethz-summaries-template-landscape/trggddjtjhqr).
+The LaTeX template of this summary can be found [here](https://github.com/MeierTobias/eth-summary-template).
 
 ## License
 

build_latex_local.sh

@@ -1,10 +1,6 @@
 #!/bin/sh
-COMMAND="latexmk -pdf -cd -interaction=nonstopmode -file-line-error -jobname=analysis_III_full_portrait -outdir=../build ./src/main.tex ; 
- sed '0,/{1}/s//{0}/' -i src/headers/flags.tex ; 
- latexmk -pdf -cd -interaction=nonstopmode -file-line-error -jobname=analysis_III_full_landscape -outdir=../build ./src/main.tex ;
- sed '0,/{1}/s//{0}/' -i src/headers/flags.tex ;
- latexmk -pdf -cd -interaction=nonstopmode -file-line-error -jobname=analysis_III_landscape -outdir=../build ./src/main.tex ;
- sed '0,/{0}/s//{1}/' -i src/headers/flags.tex ;
- latexmk -pdf -cd -interaction=nonstopmode -file-line-error -jobname=analysis_III_portrait -outdir=../build ./src/main.tex ;
- sed '0,/{0}/s//{1}/' -i src/headers/flags.tex"
+COMMAND="latexmk -pdf -cd -interaction=nonstopmode -file-line-error -jobname=analysis_III_full -outdir=../build ./src/main.tex ; 
+ sed '0,/{1}/s//{0}/' -i src/var.tex ; 
+ latexmk -pdf -cd -interaction=nonstopmode -file-line-error -jobname=analysis_III -outdir=../build ./src/main.tex ;
+ sed '0,/{0}/s//{1}/' -i src/var.tex"
 exec docker run --rm -i --user="$(id -u):$(id -g)" --net=none -v "$PWD":/usr/src/app -w /usr/src/app texlive/texlive:latest sh -c "$COMMAND"