Software used by QuantEcon

The following details the software that is used directly by QuantEcon and how to install it.

Jupyter Book

Jupyter Book provides a command line tool to build Jupyter Books and is maintained by the Executable Book Project. This is the EBP equivalent of jupinx.

To install:

pip install "jupyter-book==1.*"

Warning

An unpinned pip install jupyter-book now installs v2.x, which is built on the new MyST engine and is a different tool from the v1 documented across this manual and used to build the lecture series. Pin to 1.* until the org migrates.

More information is available at the repo

QuantEcon Book Theme

The QuantEcon book theme is a jupyter-book theme maintained by QuantEcon

It is now published on PyPI, so to install:

pip install quantecon-book-theme

Note

The shared quantecon environment pins a specific version of quantecon-book-theme (along with the other build dependencies) to ensure consistent html output across projects. Refer to that environment.yml for the exact versions in use.

See also

This is one of three themes QuantEcon maintains — see Website themes for what each one is for, including the MyST theme for Jupyter Book 2.

Jupytext

Jupytext is useful for converting between ipynb and md files or vice-versa. Myst markdown has a two-way mapping available so we can easily move between both formats.

To install:

pip install jupytext

ghp-import

ghp-import is a tool to force update github pages from local builds.

To install:

pip install ghp-import