Skip to content
jupyter/ipython notebooks demonstrating PySAL functionality
Python Jupyter Notebook Dockerfile
Branch: master
Clone or download

README.md

PySAL Notebooks Project

This project uses jupyter-book to build a book with all the notebooks of the packages in the PySAL federation. The result is available at:

http://pysal.org/notebooks

Dependencies

If you want to access the built book, simply head over to the URL above. If you want to build the book locally, you will need the following:

  • A recent version of jupyter-book
  • Unix OS: the builder relies on a few shell commands (rm, mkdir, cp, mv, cd)
  • pandoc (for .rst to .md conversion)
  • git
  • Python libraries listed in build-requirements.txt

Build process

The current build process involves two main steps:

  1. Pull repositories to extract the files used to build the book. This can be done by running the following command from the root folder:

    > python lib/build.py --pull

    This will generate a notebooks folder that contains all the files required to build the book.

  2. Test all the .ipynb files are well-formated and can be converted:

    > python lib/build.py --test_no_run

  3. Execute all the .ipynb files:

    > python lib/build.py --test_run

  4. Build the book from the downloaded notebooks. This can be done by running the following command from the root folder:

    > python lib/build.py --build

    This will create/update the docs folder in the root folder so it contains everything needed for the hosting server to serve the book. Commit the changes and the updated book will be available online shortly.

You can’t perform that action at this time.