quantecon-example

A demonstration of Jupyter Book functionality using QuantEcon Python programming source material.

How to create your own Jupyter Book

For the purposes of this project, we are replicating the content under Python Programming for Quantitative Economics. To demonstrate at a high level what has been done, we first convert each source file from rST to MyST-syntax markdown, then build the book by following the instructions in the Books with Jupyter documentation.

Creating an environment

1. conda env create -f environment.yml
2. conda activate qe-example

Building a Jupyter Book

Run the following command in your terminal: jb build book/. If you would like to work with a clean build, you can empty the build folder by running jb clean book/. If the jupyter execution is cached, this command will not delete the cached folder. To remove the build folder, you can run jb clean --all book/.

Publishing this Jupyter Book

Run ghp-import -n -p -f book/_build/html

If you are working on improving the quantecon-example, the publishing of your work is taken care by Github workflows.