Skip to content

v0.2.0: Clearwater Riverine Refactored with OOP

Compare
Choose a tag to compare
@sjordan29 sjordan29 released this 16 Jan 21:23
· 242 commits to main since this release
b6f097f

This release integrates principles of object-oriented programming into the Clearwater Riverine water quality model.

Notable changes:

  • #14 - Refactor IO to enhance code flexibility and extendibility

  • Creation of ClearwaterRiverine class with the following methods:

    • initial_conditions()
    • boundary_conditions()
    • simulate_wq()
    • quick_plot()
    • plot()
  • Splitting code into modules

    • linalg: contains LHS (left-hand side) and RHS (right-hand side) classes used for solving linear algebra systems
    • mesh: functions required for defining UGRID compliant unstructured model mesh
    • ras2dwq: contains ClearwaterRiverine class
    • utilities: functions required for calculating advection-diffusion transport equation
    • variables: define global variables
    • io: scripts for I/O
      • inputs: input reader factory
      • outputs output writer factory
      • hdf: io related to HDF files