README.md

Git and GitHub Use, Collaboration, and Workflow (IN PROGRESS)

This repository houses the source code and content files for the open access, Git and GitHub Use, Collaboration, and Workflow book tutorial and training that many contributors to the PSLmodels community use. This project uses Jupyter Book 0.7.3 to create the HTML and Jupyter notebook forms of the tutorial. This public GitHub repository hosts all the source code for the book, and the compiled Jupyter book is available at the GitHub page for this repository https://pslmodels.github.io/Git-Tutorial, up to the most recent commit to the master branch. We hope to add tutorial videos at some point in the future. This project is maintained by Richard W. Evans and Jason DeBacker.

Contributing to the book

We welcome contributions and updates to the content of the book. This is done by following fork/edit/pull-request workflow.

From your fork of this repository, you can generate your own version of the book by creating and activating a customized conda environment (virtual environment) and using the Jupyter Book build commands.

Setting up the virtual environment

The virtual environment specifications are defined in the environment.yml file. If you have not set up the conda environment, navigate to your Git-Tutorial repository folder in your terminal on your local machine and execute the following two commands. If you have already created the conda environment, then simply activate it using the second command below (skip the first command).

conda env create -f environment.yml
conda activate jb-git-tutorial

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 jupyter execution is cached, this command will not delete the cached folder.

To remove the build folder (including cached executables), you can run:

jb clean --all ./book

Notes

Put notes here.