StateDMI / Release Notes
This appendix provides information about changes that have occurred in StateDMI. A summary table is provided below, and links to details for major versions.
- StateDMI Version Numbering Convention
- StateDMI Issue Icons
- StateDMI Version History
- Known Limitations
- StateDMI Version Details - the following are separate documentation pages
StateDMI Version Numbering Convention
StateDMI versioning generally adheres to the following pattern. The version may be incremented in source code but does not become official until a public software release is made.
Major.Minor.Maintenance[Mod]
where:
Major
is a number indicating a major change to the softwareMinor
is a number indicating a minor change to the softwareMaintenance
is a number indicating a maintenance release, for example to fix a bug with no new featuresMod
is an optional modifier, for exampledev
for development version.- Numbers have traditionally been two digits and zero-padded; however, the zero-padding convention may be abandoned in the future.
The above version string is used in the software as follows, where Version
is the version as noted above:
- installation folder on Windows is
C:\CDSS\StateDMI-Version
- Windows Start menu is Start / CDSS / StateDMI-Version
- Windows install file is
StateDMI_CDSS_Version_Setup.exe
StateDMI Issue Icons
The following icons are used to indicate the type of issue in release notes.
- Known Limitation – A known limitation has been documented and may impact the user. The limitation will be addressed in a future release.
- Bug Fix – A bug has been fixed. Users should evaluate whether their work is impacted. Sometimes bug fixes impact internal code and changes may not be very visible to users.
- Remove – A feature has been removed, generally because functionality has been migrated to other code or the functionality is no longer needed (e.g., a change in methodology has resulted in a change in software features).
- Update/Change – An existing feature has been changed or enhanced. Backward compatibility is usually retained. Modifications to an existing command are considered a change.
- New Feature – A new feature has been added, such as a new command. New features may or may not be obvious to users but will generally be visible in menus.
StateDMI Version History
The following table summarizes the StateDMI release history. See the StateDMI Version Details links above for more detailed information about each version. Only recent versions are documented in detail. Comments for minor versions may be listed under a version that is publicly released. Release note items are categorized as follows, and release note items for a version are typically listed in the same order as shown to emphasize impacts on software users.
StateDMI Version History Summary (most current at top)
StateDMI Version(s) | Summary of Major Changes in Version | Release Date |
---|---|---|
5.00.00 | Major update including enabling web services, datastores, tables, Excel integration, and enhanced groundwater only well supply. | 2019-07-10 |
Known Limitations
- Releases with
dev
in the version indicate active development. A final release is made when new features are tested.