The template is currently available from arc-bath on Github. While you can fork the repository if you want to contribute to the template tutorial or build system, we recommend that you duplicate the repository to your own account (for each lesson you create. Once you have cloned you can copy (mirror) the repository to create a duplicate where you can develop your tutorial.
Currently the dependencies are a conda installation (Miniconda/Anaconda). We would recommend using an environment to manage the build system as the dependencies may grow over time to accommodate increased functionality/standardisation:
% conda create -n arc-training-bs python=3.6 jupyter
Activate/deactivate the environment with
% source activate arc-training-bs
(arc-training-bs) % source deactivate
Additionally the build system relies upon standard linux commands, e.g. make, sed.
The principle components of the build system are:
imagesnotebooks_plaintools
images - unsurprisingly contains any images that you wish to use in the lesson either for branding or content.
notebooks_plain - contain the contents of the lesson and are edited by the user. N.B. Take care when editing to close notebooks when adding, committing to a repository and particularly (if using them) when you switch between branches. More detail on the different notebook files is given in the next episode.tools - is the home of the python scripts and makefile that constitute the build system. It also has scripts for generating latex and bash magic, as well as setting up the environment on you local machine.The build works in three stages:
make render creates rendered notebooks (from notebooks_plain) in notebooks_renderedmake html renders html in html from notebooks-renderedmake pdf renders pdfs in pdf from html (Coming soon)If necessary dependencies and all notebooks are valid .html files these commands are all that is required to build your lesson.