Code for a compartmental model for describing mixing in manholes

This package implements the compartmental mixing model described in the journal article Predicting manhole mixing using a compartmental model (Sonnenwald et al., submitted). This model uses jet theory to divide a manhole into multiple zones and work out the exchange between zones. Using these values, the model then uses compartmental mixing theory to predict downstream concentrations based on upstream concentrations. This document outlines running the model and how the code functions. The accompanying document Further details and equations of a compartmental model for describing mixing in manholes provides the theoretical background and equations used.