The documentation is hosted on github pages: https://nbren12.github.io/uwnet/

The software requirements for this project are more complicated than most python data analysis projects because it uses several unique tools for running python codes from an atmospheric model written in Fortran. However, the entire workflow is containerized with docker, and can be run wherever docker is installed.

From the project's root directory the docker environment can be entered by typing

make enter

This opens a shell variable in a docker container with all the necessary software requirements.

To run the whole workflow from start to finish, type

snakemake -j <number of parallel jobs>

This will take a long time! To see all the steps and the corresponding commands in this workflow, type

snakemake -n -p

This whole analysis is specified in the Snakefile, which is the first place to look.