Skip to content

StateMod Documentation (for Software Developers)

This documentation is the developer manual for Colorado's Decision Support Systems (CDSS) StateMod water allocation model software. This documentation has been updated for the next release after StateMod 17.0.3 (version number and release are pending).

If you are reading this documentation, you have an interest in learning how StateMod is designed, are a member of the software development team, or perhaps wish to contribute software code enhancements or otherwise provide input to the project. This documentation is intended to provide sufficient information to software developers to streamline understanding of the StateMod code and developer environment. It is expected that software developers are technically competent and follow conventions of the open source StateMod project.

This documentation page includes the following sections:

How to Use this Documentation

This documentation is a companion to the StateMod source code and provides guidance for software developers that modify and support StateMod.

It is the intended to create StateMod executable programs for Windows 10+ and Linux, with Windows being the primary version. 64-bit software is the target environment. Review the developer documentation for StateMod version 17.0.3 and earlier for 32-bit software information. This documentation includes information for multiple computer environments and will be filled out as resources can be applied to each configuration. Icons for Linux Linux and Windows Windows are included to help indicate documentation specific to an operating system.

The documentation is organized with the first sections focusing on setup for a new developer and common development tasks. The reference sections at the end provide information that may be of use but are typically not used day to day. Use the search feature of this website to find specific information.

The navigation menu on the left provides access to pages in the documentation. The navigation menu on the right provides access to sections on the page. If the page is viewed in a narrow window the navigation menus may be compressed into an icon.

Colorado's Decision Support Systems

Colorado's Decision Support Systems (CDSS, https://cdss.colorado.gov/) has been developed to answer important questions about Colorado's water resources. CDSS efforts are led by the Colorado Water Conservation Board (CWCB) and Colorado Division of Water Resources (DWR).

CDSS Website

One component of CDSS is the StateMod water allocation model, which estimates water allocation given water supply and demand and physical and legal (water right) constraints on water decisions. StateMod results are linked to the StateCU consumptive use model and in some basins the MODFLOW groundwater model.

In late 2016, the CWCB funded the OpenCDSS project to move StateMod and other CDSS software to open source licensing and establish open source software projects. The Open Water Foundation was contracted to lead the OpenCDSS project.

License

The license for this documentation is the Creative Commons CC-BY 4.0 license.

The StateMod software is licensed using the GPL v3 license.

Source Repository on GitHub

The source files for this documentation are maintained in the StateMod GitHub repository.