Overview

This documentation is intended for different types of stakeholders interested in the Sustainable Water through Integrated Modeling Framework (SWIM), which is part of the Sustainable Water Resources project sponsored by the United States Department of Agriculture. Below is a brief description of the intended use and target audience of each section.

Features
Intended for any type of stakeholder that wants to get familiar with the functionality and limitations of SWIM.

Tutorials
The SWIM Interface tutorial is intended for users experimenting with scientific models on a user friendly graphical interface. User types include, and are not limited to: policy makers, participatory modeling moderators, water users, etc.

SWIM Webservices are intended for knowledgeable users. Examples of such stakeholders are listed below.

  • Application and frontend developers: Creation of custom interfaces that interact with SWIM Webservices.
  • Developers, scientists or experimenters: Creation of scripts for bulk model execution.

Scientific Models
Contains documentation regarding scientific models currently implemented in SWIM. The modeling software used can either be: enabled for online use or limited to offline execution (canned results).

System Architecture
The System Architecture section is intended for stakeholders interested on the high level technical aspects of SWIM. The documentation follows software architecture view points extracted from Clements et. al.

SWIM Backend
Provides a detailed technical view on the architecture, development and deployment of SWIM Webservices. This section is intended for system architects, developers and scientists.

SWIM Frontend
Provides technical views on the architecture, development and deployment of the SWIM graphical user interface. This section is intended for web developers and stakeholders interested in how the UI of the system is implemented.

Source Code
Provides links to any system code available for free distribution, use and modification. It also provides information on development history, future development, maintenance plans and release information of SWIM.

Acknowledgements

This material is based upon work supported by the United States Department of Agriculture under Grant No. 2015-68007-23130.

Participating Institutions

University Logos

  • The University of Texas at El Paso
  • New Mexico State University
  • University of New Mexico
  • Michigan Technological University
  • Universidad Autonoma de Ciudad Juarez
  • Texas A&M University

References

Clements, P., Garlan, D., Bass, L., Stafford, J., Nord, R., Ivers, J., & Little, R. (2002). Documenting software architectures: views and beyond. Pearson Education.

Contacts

Bill Hargrove, PI
Center for Environmental Resource Management
The University of Texas at El Paso
wlhargrove@utep.edu