/kjbilton-lab0

Analysis and Report for Lab 0

Primary LanguageJupyter Notebook

Binder

NE 204 Lab 0

Overview

In this analysis, we perform an HPGe energy calibration using spectroscopic data from a number of gamma-ray sources.

Usage

Environment

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 ne204lab0 (specified in the file environment.yml) with all Python packages required to run the analyses. This environment can be activated using

source activate ne204lab0

Getting the data

Data is included for reproducibility purposes, but you could also download it using

make data

Validating the data

Compute the MD5 checksum of the data and compare it using

make validate

The python script scripts/validate.py was included to provide a uniform, cross-platform validation tool.

Running 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.

Testing

Modules can be tested from the top-level directory with the command

make test

This runs all tests within the test directory.

Building the report

This report uses the IEEETran TeX class, which is not installed by default. If you don't already have this class installed on your system, you can use it locally by running

make ieee

which will download the file IEEETran.cls. The report can then be built using

make