This repo contains the skeleton of a project for building lab reports from
source using make and pdflatex (texlive).
For a more fleshed-out example of writing a lab report in LaTeX, see the
lab_report_example directory of
this repo.
You must first have conda installed before the environment can be built. To install the environment, run
make env
This command will create a conda environment named ne204 (specified in the file environment.yml) with all Python packages required to run the analyses.
All code can be ran and figures saved by running
make analysis
Alternatively, one can run all notebooks individually and explore intermediate results along the way.
Modules can be tested from the top-level directory with the command
make test
This runs all tests within the test directory.
# Create a new directory for your report
mkdir my_lab_report && cd $_
# Create an empty repository
git init
# Initialize the repo with the template
git fetch --depth=1 -n https://github.com/kjbilton/lab_report_template.git
git reset --hard $(git commit-tree FETCH_HEAD^{tree} -m "initial commit")