- Clone this repo
- Install Conda and Julia on your target operating system. If on Windows, install the Windows Substyem for Linux
- Assuming that python is in your path, install the dependencies
pip install sphinxcontrib-bibtex
- Clone with
git clone https://github.com/QuantEcon/sphinxcontrib-jupyter
cd
to thesphinxcontrib-jupyter
- Install with
python setup.py install
- In a Julia terminal run
using Pkg
pkg"add IJulia; precompile"
pkg"add InstantiateFromURL; precompile"
using InstantiateFromURL
activate_github("QuantEcon/QuantEconLecturePackages", tag = "v0.9.5")
activate_github("QuantEcon/QuantEconLectureAllPackages", tag = "v0.9.5")
This may take a long time, as it will install and precompile every package used by the lecture notes.
- To generate the notebooks and execute them
- In the main directory of the repo:
make jupyter
ormake jupyter-tests
if you want it with testing code
- Alternatively, you could edit
rst_files/conf.py
and modify the settingjupyter_drop_tests = False
- Execute all of the notebooks with
./run-all-notebooks.sh
. This will take a long-time the first execution. cd
to the/notebooks
directory, and runjupyter lab
to examine them.
- In the main directory of the repo:
All contributions should be made through PR. If you aren't an admin on the repo, you might need an admin review before the PR is mergeable. You can request reviews from the right hand dropdown.
On top of the above, we have the following dev scripts: