search

MeierTobias / eth-analysis-3

This repository contains the LaTex source of the Analysis III course summary.
MIT License
1 stars 0 forks source link

readme

ETHZ Analysis III

action status

This repository contains the LaTex source of the Analysis III course summary.
It was originally created by Benno Kaeslin, Linard Furck, Sandro Christen, Markus Fuchs, Andre Jauch in 2016 and extended by the contributors of this repository.

A pre-build pdf file can be downloaded here:

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 or build it with your native installed LaTeX compile of choice. If you want a hassle-free way to work with our LaTeX project, we recommend using Docker.

Docker (recommended)

  1. Make sure you have Docker installed on your system. If you don't have it already, you can download and install it from the official Docker website.

  2. After you launched the docker daemon (started Docker Desktop) you can simply run execute the ./build_latex_local.sh file to generate the pdf files. They are located in a newly created subfolder called build.
    (Most probably you have to change the execution permissions with chmod +x build_latex_local.sh before you are able to run the script for the first time.)

Native LaTeX compiler

If you want to use your own native installed LaTeX compiler we recommend to use TeXLive which integrates well within visual studio code.

If you use the LaTeX Workshop extension you can add the following lines to your .vscode/settings.json file to configure the system:

Specify an output directory:

"latex-workshop.latex.outDir": "../build",

Remove unnecessary build files (slows down compilation time):

"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",
"latex-workshop.latex.clean.subfolder.enabled": true,

To enable the LaTeX checker ChkTeX:

"latex-workshop.linting.chktex.enabled": true, 
"latex-workshop.linting.chktex.exec.args": ["-wall","-n8","-n13","-n21","-n22","-n30","-n46","-e16","-q"],

To get more information about the different warnings search for your warning code in the ChkTeX documentation. 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.

Prerequisites

The images and other compressed files are managed by git-lfs. Therefor you need to install git-lfs 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. The file 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.

Template

The LaTeX template of this summary can be found here.

License

Distributed under the MIT License. See LICENSE for more information.