Professional Documents
Culture Documents
Abstract—This document serves as a guide for writing you are at using word processing tool. Finally, if you are
laboratory reports using LaTeX for the course ECE 469 considering a career in academic (or industry) research,
– Power Electronics at University of Illinois at Urbana- knowing LaTeX will be very beneficial, as it is the
Champaign. It introduces the features of LaTeX and also most commonly used software for preparing academic
serves as a template for the report so that students can
manuscripts for professional conferences and journals.
modify the contents of this guide to produce their own
lab reports. Normally, the abstract should contain a short
description of the experiment, and some key results that
were obtained. A. Do I have to use LaTeX?
While you are strongly encouraged to use LaTeX,
I. I NTRODUCTION you are not required to do so. You are, however,
required to produce a document that adheres to the
Y OU are highly encouraged to use LaTeX for your
laboratory reports. LaTeX is a high-quality type-
setting system; it includes features designed for the
styles presented in this template. If you choose to use
something else (such as MS Word), your final document
production of technical and scientific documentation [1]. should be indistinguishable from a report produced using
The idea is that with LaTeX, the authors would not this template. That includes the section and subsection
need to worry about the appearance of the document and headings, the abstract, title, caption placement for figures
can instead concentrate on producing the best contents. and tables, footnotes, and references. You are likely to
Despite the intention of making the life easier for sci- spend significantly more time on formatting your word
entific writers, LaTeX can have a steep learning curve. processing tool than what it would take to learn this
Therefore, we are providing this guide and template to template – consider yourself warned.
make your learning experience as easy as possible. This
guide is not meant to be an exhaustive tutorial, otherwise
III. S ETTING - UP L AT E X
it would be over 200 pages long instead of only 6. Rather,
we provide this guide to get you started and direct you The links to the software presented in this section
to the best resources available. can be found on the ECE469 course website [2]. There
are two basic components that are needed to work with
II. W HY L AT E X? LaTeX, a LaTeX compiler and a LaTeX editor. The
The main reason why we ask you to prepare your lab- most common LaTeX distribution to use on Windows
oratory reports in LaTeX is for consistency. In previous is MiKTeX. When downloading MiKTeX, choose the
years, students have struggled with (and received sig- net installer from Other Downloads, instead of the basic
nificant grade penalties) basic report formatting. While installer, so that all packages are installed. The 32-
we realize that many of you are quite capable of using bit version is recommended even if you have a 64-
Microsoft Word and other word processing tools, very bit machine, to maximize compatibility. Linux and Mac
few of you have extensive experience with you figure users can use Tex Live and MacTex respectively. One
captions, tables, and the structure of a professional LaTeX editors that is recommended is Texmaker for its
looking report. Moreover, by using LaTeX, the content ease of use and cross-platform support for Windows,
is what will make your report stand out, not how good MacOS and Linux.
2
latex guide.tex This is the LatTex source file that include the contents of this template
latex guide.pdf This is the compiled pdf file you are reading now
header.tex This file includes the essential packages and parameter settings
references.bib contains the bibliography information
IEEEtran.bst defines IEEE bibliography style
IEEEtran.cls defines IEEE document style
images the folder that contains figures and plots
Matlab the folder that contains Matlab scripts that generate plots
*.out *.ent *.blg *.aux etc... These auxiliary files are generated during compilation and can be ignored
IV. U SING THIS T EMPLATE follow % are comments and will not be interpreted by
Different from the common WYSIWYG (what you the compiler. A basic flow of the LaTeX document is
see is what you get) typesetting software such as MS shown on the next page.
Word, LaTeX compiles the source file and creates a pdf
as the final output, much like a simple programming
language. The source codes for this template can be B. Typing math
downloaded as a zip package from the course website. Perhaps one of the most compelling reason to use
The files included in the package as well as their LaTeX to typeset a scientific paper is the relative ease
functions are listed in Table I. When reading this guide, of typing out beautiful math equations and symbols.
you should open the LaTeX source file and compare the There are two modes of displaying math in LaTeX, inline
contents of the source and the contents of this guide. math and displayed math. Inline math is used when you
The source is commented to make it easier for you to want to include some math symbols and equations in
understand. After you have gone through this guide, you an ordinary sentence. It is done using $$ environment;
should be able to start on your first report by modifying everything inside the $$ is interpreted in math mode. For
this guide or the report guide given in a separate folder. example, $ R_1=10.1 \, \Omega $ gives R1 =
To compile a LaTeX document using Texmaker, 10.1 Ω. Please note that white space is automatically
open the latex guide.tex and click on arrow to the left ignored in the math environment, but can be added using
of Quick Build. Texmaker should compile the latex ’\,’ or ’\.’. Displayed math is used when you want
document and open the resultant pdf file with a built-in to write important equations that occupy a whole line
pdf viewer. You can also use the keyboard shortcut, F1. themselves. For example,
By default, Texmaker should use PDFLaTeX as the build
\begin{equation}
tool. If not, or if you are using other latex editors, please V_{out}=\frac{2V_{in}}{\pi} \int_\deltaˆ{\pi-
make sure that you choose PDFLaTeX as the toolchain. \delta} sin(\omega t) \,d(\omega t)
In addition, if you are making LaTeX document in \end{equation}
linux environment or if you are using editors other
gives
than Texmaker or Texstudio, you may have to add ”- Z π−δ
shell-escape” option in the PDFLaTeX command in the 2Vin
Vout = sin(ωt) d(ωt) (1)
confiugration of your LaTeX editor. π δ
Some common maths symbols that you might use are
V. W RITING WITH L AT E X included in the following examples.
A. Basic syntax ∞
4 X1 nπx
f (x) = sin( ) (2)
Commands and special characters in LaTeX are π n L
n=1,3,5...
invoked by using the backslash ’\’. For example,
\section indicates the start of the section and −1 0 0 1
\centering makes the contents to be center aligned. ẋ = 0 −1 0 x + 0 u (3)
Double backslash ’\\’ makes a line break while para- 0 0 −1 0
| {z }
graphs are separated by an empty line. Characters that A
3
\begin{document}
\section{Introduction}
This is the first paragraph of the first section. The section title
is Introduction.
\section{Theory}
\section{Experimental Results}
\section{Discussion}
\subsection{Part 1}
Depending on your needs, you may use subsections and subsubsections.
\end{document}
C. Making plots 25
V
out,ave
Graphs and plots are essential in every scientific Vout,rms
writing. This LaTeX template can display a number of 20 Vout,ave −theory
different image formats, such as Encapsulated Postscript V −theory
out,rms
(EPS), PDF, PNG and JPEG. 15
Voltage /V
TABLE II: Input and output voltage, current and power of buck converter at various duty ratios