Creating a Jupyter Book with The Turing Way

Oct 5, 2020 — Oct 9, 2020

Jupyter Book is an open source project for building publication-ready online books with computational files. The Turing Way is a community-led book project on learning computational skills, which is hosted online as a Jupyter Book. In this tutorial, you will learn about the collaborative nature of both projects and create your own Jupyter Book using files and chapters from The Turing Way as examples.

Sessions in detail:

The topics and activities to be covered in this workshop are the following:

  • We will start by introducing The Turing Way and Jupyter Book.
  • The session leads will present The Turing Way as a community-developed book project on research reproducibility, project design, communication, collaboration and ethics.
  • A demo of The Turing Way’s GitHub repository will explain how a Jupyter book is created and how they are hosted online.
  • A hands-on session will be carried out to create a Jupyter Book using The Turing Way chapters as examples.
  • We will explain what Continuous Integration (CI) is and how to deploy CI tests using GitHub Actions.
  • We will show the collaborative workflow of Jupyter Book that allows GitHub based contributions by the users of the book.
  • The session will end with sharing details on how participants can gain further support when working with Jupyter Books and The Turing Way.

Learning outcomes

In this tutorial, our learners will:

  • Get introduced to The Turing Way and Jupyter Book projects as reproducible and collaborative platforms for community-developed computational resources.
  • Learn how to create and structure a Jupyter Book using example chapters from The Turing Way.
  • Configure and personalise their Jupyter Book locally and connect it to an online GitHub repository.
  • Learn how Jupyter Notebooks can be used as chapters and executed using Binder.
  • Learn what Continuous Integration (CI) and Continuous Deployment (CD) are and how to use them with GitHub Actions.
  • Get introduced to Sphinx-based features in Jupyter Book for citing external resources and cross-referencing its chapters.