Lectures in Quantitative Economics: Source Files
Python version
This repository contains
-
the
rst
source files for each python lecture in Quantitative Economics with Python, in directorysource/rst
-
supporting Python code in
source/_static/code/
-
supporting figures, PDFs and other static assets in
source/_static
.
Building notebooks
(Jupinx)[https://jupinx.quantecon.org] should be used to build this set of lectures.
Style Guide - Writing Conventions
Mathematical Notation
Matrices always use square brackets. Use \begin{bmatrix} ... \end{bmatrix}
Sequences use curly brackets, such as \{ x_t \}_{t=0}^{\infty}
The use of align environments can be done using the \begin{algined} ... \end{aligned}
as it is not a full math environment and works within the equation wrapping of sphinx.
"Independent and identically distributed" is abbreviated to "IID".
The headings should not use math-environment.
Labels must be written in all small alphabetical letters. Any special character should be avoided in labels except "dash" i.e "-"
All the cite key must use the default google scholar bibtex conventions.
Emphasis and Definitions
Use bold for definitions and italic for emphasis. For example,
- A closed set is a set whose complement is open.
- All consumers have identical endowments.
Titles and Headings
- Capitalization of all words for all titles.
Example “How it Works: Data, Variables and Names”
Adding References
Adding a Citation to a Lecture
To add a reference to the text of a QuantEcon lecture you need to use the :cite:<bibtex-label>
directive.
For example
:cite:`StokeyLucas1989`, chapter 2
is rendered rendered in HTML and LaTex as:
[SLP89], chapter 2
Adding a new reference to QuantEcon
To add a new reference to the project, a bibtex entry needs to be added to QuantEcon.lectures/_static/quant-econ.bib
.
Sphinx and Restructured Text
Editing
The syntax of the source files is reStructuredText.
Here is a nice primer on how to write reStructuredText files.
Here is the documentation for the Jinja template syntax.
Helpful Links
Converting notebooks to RST files
Sometimes it's convenient to write a lecture as a notebook and then convert to RST
This guide is provided by TJS and requires pandoc 2.6 or newer
(Use pandoc --version
to test)
-
This step is necessary only if you want to strip out dollar signs from maths
python latex_space_strip.py [myinputfile.ipynb] -o [myoutputfile.ipynb]
-
To convert, use
pandoc [myfilenamenew.pynb] -f ipynb+tex_math_dollars -t rst -s -o [newfilename.rst]