Loading repository data…
Loading repository data…
maurovm / repository
LaTeX class for an undergraduate 4th year project (4YP) report or a DPhil / PhD doctoral thesis for a student of the Department of Engineering Science at the University of Oxford
A transparent discovery signal based on current public GitHub metadata.
This score does not audit code, security, maintainers, documentation quality, or suitability. Verify the repository and its current documentation before adoption.
This repository contains a LaTeX class (OxEngThesis) to write formal academic documents for a student of the Department of Engineering Science at the University of Oxford. For example, my undergraduate students have used this class to write 4th-year project (4YP) reports. My doctoral students have typically used this class to write their 1st-year Transfer of Status report, 2nd-year Confirmation of Status report and their final DPhil thesis. The typical 4YP report contains around 50 pages, whereas a doctoral thesis is a much larger document.
Although I originally created this class for a student at Oxford, I also included in this repository some examples for a PhD thesis for the Massachusetts Institute of Technology and (cough, cough) the University of Cambridge. It should be easy for you to adjust this class to suit the requirements of your academic institution.
LaTex itself is very portable. However, I developed this class under Linux and macOS environments using the latest LaTeX distributions. I have not tested compiling a LaTeX document in Microsoft Windows, but some of my students reported that it works. If you find any problems for Windows, please report any issues to me. Event better, I encourage you to contribute your fixes.
"OxEngThesis" is free software: you can redistribute it or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2 only. Check the file COPYING for more information on the license and copyright.
As a research student, a proportion of your time will be devoted to writing science in a formal academic style. There are many resources that will help you to write your thesis, such as Writing your thesis, Completing your doctorate, Essay and dissertation writing skills and also other resources for new students. Steven Pinker's talk on Linguistics, Style and Writing in the 21st Century will provide you with sound advice on writing (hopefully you will put the passive voice to rest after watching the video).
My students have found very helpful to use the LaTeX typesetting system to write reports, theses, journal papers or other academic documents. You can write your LaTeX documents from scratch, however, it is often easier to start with an already written class template. This way you can focus on (as your supervisor expects) writing about your exciting research contributions, rather than spending time formatting your document or applying other cosmetic changes that just waste everybody's time and distract the reader.
The OxEngThesis class is based on the memoir package, with the addition of several other packages and extra features useful to format a typical academic document. The main class file is oxengthesis.cls. One sample source file is provided: sample_dphil_thesis.tex to get you started writing your thesis. You can check the sample_dphil_thesis-sample_output.pdf file to view an example of the output PDF document for a doctoral thesis.
This tutorial summarises some of the features available in the OxEngThesis class. Take a look at the oxengthesis.cls file and the sample_dphil_thesis.tex source file for a more complete overview. Additionally, this tutorial is replicated as "Chapter 0: The OxEngThesis LaTeX class" in the sample_dphil_thesis-sample_output.pdf, so you can view examples of the LaTeX syntax to write your document.
There are several options for writing in LaTeX, including online versions such as Overleaf. I don't recommend online editors, as you will be writing long documents with several figures, tables and other elements. In my experience, having LaTeX installed locally in your computer is a better option.
You will need a modern LaTeX compiler installed in your system, at minimum version 2017. Most modern operating systems use TexLive as the preferred LaTeX typesetting system. If you are using Linux, TexLive is already pre-installed or is readily available from your distribution's software repository, for example: LaTeX in Fedora and LaTeX in Ubuntu. For macOS, you can download and install the latest MacTeX distribution. For Microsoft Windows, follow the installation instructions described in TexLive on Windows.
Install the Carlito font (if it's not already installed in your system). Follow the instructions for your particular operating system in the fonts directory, for example for Linux or macOS. If you are using Microsoft Windows, also install the Latin Modern Math font.
There are several editors available that will make your life easier when writing LaTeX documents and, ultimately, generating the final PDF file (a.k.a compiling the LaTeX source files). For macOS, Texifier works really well. Good editors for Linux are Kile and TeXMaker. If you know what software is good for Microsoft Windows, let me know so I can add it to my recommendation list.
The LaTeX files in this repository require the LuaLaTeX engine. You editor should allow you to configure LuaLaTeX as the typesetting engine for your document and automatically take care of the compilation process to generate the final PDF document.
This tutorial is replicated as "Chapter 0: The OxEngThesis LaTeX class" in the sample_dphil_thesis-sample_output.pdf, so you can review examples on how to write your LaTeX document.
After you installed your preferred LaTeX editor, make a copy of the sample_dphil_thesis.tex sample file provided in this repository. Throughout this tutorial, I will call this new file your "main LaTeX source file". The minimum content you need is:
\documentclass{oxengthesis}
\title {The title of your thesis}
\author {Your name}
\college {The name of your college}
\supervisor {The name(s) of your supervisor(s)}
\date {The academic term of submission}
From your "main LaTeX source file", remove the line that includes the OxEngThesis class documentation. It is a line similar to:
\include{oxengthesis_class_documentation}
NOTE: The line above includes the LaTeX version of this README file. It shows how you can use the features provided by the OxEngThesis class in your document. It is numbered as "Chapter 0" in the sample PDF file sample_dphil_thesis-sample_output.pdf so not to change the flow of the rest of the document.
The frontmatter of the thesis will be automatically created depending on the type of document you are writing, either a doctoral thesis or a project report. If you want more control, you can review how the '\makefrontmatterpages' command is defined in the oxengthesis.cls class file. If you want all the sections in the frontmatter to appear, you will need to create the following files:
If any of the files above are missing, that particular page won't be created in the frontmatter. This is useful if you are just preparing a draft version of your thesis for your supervisor to correct.
Similarly for the backmatter part of your thesis, add all the BibTeX citations to a file named references.bib if you want the "Bibliography" section to be created at the end of your document.
There are two Key milestones for which DPhil students are expected to submit substantial piece of written research work, or reports. They are the "Transfer of Status" at the end of your first year, and the "Confirmation of Status" at the end of your second year.
For these milestones, you will often be required to submit a report with all the details of your research contributions. This document is often around 50-60 pages in length and does not need all the sections that a doctoral thesis has (i.e. declaration, dedication or list of publications).
You can write a Transfer of Status report by simply providing the "report" option when you load the OxEngThesis class, and defining the "degree" variable as shown in the following code snippet:
\documentclass[report]{oxengthesis}
\title {The title of your report}
\author {Your name}
\degree {{\huge Transfer of Status Report}}
\college {The name of your college}
\supervisor {The name(s) of your supervisor(s)}
\date {The academic term of submission}
You can write a Confirmation of Status report by simply providing the "report" option when you load the OxEngThesis class, and defining the "degree" variable as shown in the following code snippet:
\documentclass[report]{oxengthesis}
\title {The title of your report}
\author {Your name}
\degree {{\huge Confirmation of Status Report}}
\college {The name of your college}
\supervisor {The name(s) of your supervisor(s)}
\date {The academic term of submission}
Note that the "report" package option is just a shortcut to not include the dedication, declaration and publications pages and format the title page accordingly.
If you are an undergraduate student at the University of Oxford reading Engineering Science, you will carry out a self-led project during your fourth year. It usually involves original research or significant design and construction work, undertaken in close consultation with an academic supervisor. At the end of your project (usually by the beginning of Trinity term), you will need to submit a report with all the details of your research contributions. This document is often around 50 pages in length and does not need all the sections that a doctoral thesis has (i.e. declaration, dedication or list of publications).
You can write a 4YP report by simply providing the "report" option when you load the OxEngThesis class, and defining the "degree" variable as shown in the following