Developer documentation

“cruise-control” (restricted link) contains detailed instructions for building and maintaining the software stack, and deploying it on CSIRO organisational infrastructure. Research partners can naturally access that documentation upon request: the content is not sensitive but kept private for logistical reasons.

Technical blog posts

A few posts that are related to this hydrologic simulation software stack:

• Presenting doxygen C++ API documentation via MkDocs with doxybook2
• Generate programming language bindings to a C API
• Azure devops CI pipeline for hydrologic forecasting software
• Compiling C++ libraries to WebAssembly - Part 1
• Windows installer with WiX 4 - part 1

Release and versioning

The streamflow forecasting software stack comprise a dozen or so public or private git repositories. Co-evolving these repositories is not trivial. Each component may have a versioning rationale that is orthogonal to others. However for reproducibility we need to have “meta-releases” that are aggregates of components with a clear, traceable lineage.

As of 2023-01:

• Diagram that explains the overarching system to release/tag.