This repository contains Colorado's Decision Support Systems (CDSS) Java library for common packages. These packages are used by all CDSS applications and many libraries.
Eclipse is used for development and repositories currently contain Eclipse project files to facilitate setting up the Eclipse development environment. Development on library code usually occurs while developing an application such as TSTool, rather than the library alone, because software requirements come from application development.
See the following online resources:
- Colorado's Decision Support Systems (CDSS)
- OpenCDSS - currently hosted on the Open Water Foundation website while the OpenCDSS server is configured
- TSTool Developer Documentation - application that uses this library
See the following sections in this page:
- Repository Folder Structure
- Repository Dependencies
- Development Environment Folder Structure
- Version
- Contributing
- License
- Contact
The following are the main folders and files in this repository, listed alphabetically. See also the Development Environment Folder Structure for overall folder structure recommendations.
cdss-lib-common-java/ Source code and development working files.
.classpath Eclipse configuration file.
.git/ Git repository folder (DO NOT MODIFY THIS except with Git tools).
.gitattributes Git configuration file for repository.
.gitignore Git configuration file for repository.
.project Eclipse configuration file.
.settings Eclipse configuration file (may remove in the future).
bin/ Eclipse folder for compiled files (dynamic so ignored from repo).
conf/ Configuration files for installer build tools.
dist/ Folder used to build distributable installer (ignored from repo).
doc/ Working folder for Javadoc creation.
graphics/ Graphics files used in library code.
lib/ Third-party libraries.
LICENSE.md Library license file.
nbproject/ NetBeans project (legacy, may be removed).
README.md This file.
resources/ Additional resources.
src/ Source code.
test/ Unit tests using JUnit.
Repository dependencies fall into two categories as indicated below.
This library does not depend on any other repositories.
The following repositories are known to depend on this repository:
| Repository | Description |
|---|---|
cdss-app-statedmi-main |
StateDMI main application code. |
cdss-app-tstool-main |
TSTool main application code. |
cdss-lib-cdss-java |
Library that is shared between CDSS components. |
cdss-lib-common-java |
Library of core utility code used by multiple repos. |
cdss-lib-dmi-hydrobase-java |
Library to directly access Colorado's HydroBase database. |
cdss-lib-dmi-hydrobase-rest-java |
Library to access Colorado's HydroBase REST API. |
cdss-lib-dmi-nwsrfs-java |
Legacy library to access National Weather Service River Forecast System (NWSRFS) data files. |
cdss-lib-dmi-riversidedb-java |
Legacy library to access Riverside Technology forecast system database. |
cdss-lib-dmi-satmonsys-java |
Legacy library to directly access Colorado's Satellite Monitoring System database. |
cdss-lib-models-java |
Library to read/write CDSS StateCU and StateMod model files. |
cdss-lib-processor-ts-java |
Library containing processor code for TSTool commands. |
| StateView - repository is being finalized | HydroBase viewer. |
| StateMod GUI - repository is being finalized | StateMod graphical user interface. |
The following folder structure is recommended for software development. Top-level folders should be created as necessary. Repositories are expected to be on the same folder level to allow cross-referencing scripts in those repositories to work. TSTool is used as an example, and normally use of this repository will occur through development of the main CDSS applications. See the application's developer documentation for more information.
C:\Users\user\ Windows user home folder (typical development environment).
/home/user/ Linux user home folder (not tested).
/cygdrive/C/Users/user Cygdrive home folder (not tested).
cdss-dev/ Projects that are part of Colorado's Decision Support Systems.
TSTool/ TSTool product folder (will be similar for other applications).
eclipse-workspace/ Folder for Eclipse workspace, which references Git repository folders.
The workspace folder is not maintained in Git.
git-repos/ Git repositories for TSTool.
cdss-lib-common-java/ This repository.
...others... See application developer documenation and README for full list.
A version for the library is typically not defined. Instead, tags are used to cross-reference the library version with commit of application code such as TSTool. This allows checking out a version of the library consistent with an application version. This approach might need to change if the library is seen as an independent resource that is used by many third-party applications.
Contributions to this project can be submitted using the following options:
- Software developers with commit privileges can write to this repository as per normal OpenCDSS development protocols.
- Post an issue on GitHub with suggested change. Provide information using the issue template.
- Fork the repository, make changes, and do a pull request. Contents of the current master branch should be merged with the fork to minimize code review before committing the pull request.
See also the OpenCDSS / protocols for each software application - currently hosted on the Open Water Foundation website while the OpenCDSS server is being configured.
Copyright Colorado Department of Natural Resources.
The software is licensed under GPL v3+. See the LICENSE.md file.
See the OpenCDSS information for overall contacts and contacts for each software product.