https://github.com/guritheochem/phd-thesis-template

A Template for a PhD Thesis using LaTex
https://github.com/guritheochem/phd-thesis-template

latex latex-book latex-template latex-thesis phd phd-latex phd-thesis phd-thesis-latex phd-thesis-template

Last synced: about 2 months ago
JSON representation

A Template for a PhD Thesis using LaTex

Host: GitHub
URL: https://github.com/guritheochem/phd-thesis-template
Owner: GuriTheoChem
License: gpl-3.0
Created: 2024-02-11T11:33:48.000Z (over 1 year ago)
Default Branch: main
Last Pushed: 2024-05-02T14:41:04.000Z (about 1 year ago)
Last Synced: 2025-04-04T22:12:43.066Z (about 2 months ago)
Topics: latex, latex-book, latex-template, latex-thesis, phd, phd-latex, phd-thesis, phd-thesis-latex, phd-thesis-template
Language: TeX
Homepage:
Size: 6.16 MB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE

Awesome Lists containing this project

README

# PhD Thesis Template

GitHub repository for a PhD Thesis template using LaTex.

[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)
[![GitHub release (latest by date including pre-releases)](https://img.shields.io/github/v/release/GuriTheoChem/phd-thesis-template?include_prereleases)](https://github.com/GuriTheoChem/phd-thesis-template/releases)
![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/GuriTheoChem/phd-thesis-template/.github%2Fworkflows%2Frelease.yml)
![GitHub forks](https://img.shields.io/github/forks/GuriTheoChem/phd-thesis-template)
![GitHub Repo stars](https://img.shields.io/github/stars/GuriTheoChem/phd-thesis-template)

## Using the Template

Read this [article](https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template) from GitHub Docs on how to create a repository from a template.

1. Click Use this template button and select Create a new repository.

use this template

2. Select with which account you want to create the repository and give it a name.

3. Check out any additional options you want to incorporate.

4. Click Create Repository and you are all set.

## Building the PDF of the Thesis

- To build the pdf of the Thesis, execute the following:

```bash
latexmk -pdf -output-directory=build src/main.tex
```

> Note: I use `latexmk` for an automated compilation of this template pdf as it has cross-references(bibliography, table of contents). I do not test any other compilers. Please read more about choosing a compiler on this overleaf [article](https://www.overleaf.com/learn/latex/Choosing_a_LaTeX_Compiler#TeX_distributions).

- The pdf named [main.pdf](build/main.pdf) is built in the [build/](build) folder.

- To get the pdf of a particular release version, go to the release and find it in the assets.

## Plots

- To build the new plots, modify the [generate_plots.py](src/generate_plots.py) as you wish and execute the following:

```bash
python3 src/generate_plots.py
```

> Note: The images of the plots for this are already generated in this project repository and are in the [plots/](src/contents/figures_and_plots/plots).

This is of course only one example way in which a user can generate plots for their LaTex Document. Feel free to play around and incorporate your prefered way.

## Screenshots