Skip to content

Directory structure

Richard Measures edited this page Oct 11, 2019 · 6 revisions

The directory structure of the HapuaModel repository is:

hapuamod is structured as a python "package" containing all of the main model code within python "modules". The main modules are:

  • core - main code for running model, calls other modules and contains main time-stepping loop.
  • coast - calculation of longshore and cross-shore transport rates
  • riv - calculation of river hydrodynamics and bedload transport
  • mor - morphological updating including interaction of different model components
  • loadmod - reading model inputs and all required pre-processing/variable initialisation.
  • out - functions to write model outputs to netCDF file.
  • geom - basic geometry functions for converting between real-world and model coordinate systems and dealing with spatial interaction of different model components.
  • visualise - plotting functions
  • animation - function to create an animation by post-processing netCDF outputs.

Inputs contains the model configuration file and other associated input files for an example model of the Hurunui Hapua.

Preprocessing contains scripts to help prepare model inputs.

Scripts to test different specific parts of model functionality during model development.

Clone this wiki locally