Jupyter Book Conda Environment

This repository contains a Conda environment to create computational publications with Jupyter Book and host published content on GitHub Pages.

Prerequisites

To run and use this environment locally, you will need:

• Conda (Miniconda or Anaconda)

Local Setup Instructions

Local instructions expect the user has cloned or forked the GitHub repository. In a terminal, navigate to the folder containing the local repository.

From the terminal, you can create and activate the Conda environment.

Create environment:

$ conda env create -f environment.yml

Activate environment:

$ conda activate computational-publications

Jupyter Book Instructions

This repository contains a Makefile that automates the commands to clean, build, and publish the Jupyter Book. To complete these tasks, change the jupyter_book variable to the name of the folder containing the Jupyter Book and change the github_pages_commit_message to a commit message the captures the updates.

Once all variables are set, run the following command to clean, build, and publish the updated Jupyter Book:

$ make publish-book

Contents

Makefile

Contains instructions to automate Jupyter Book builds and GitHub commits.

environment.yml

Contains information to set up the Conda environment to create computational publications with Jupyter Book.