GSSHA Download

From Gsshawiki
Revision as of 16:30, 9 December 2024 by Aabyrd (talk | contribs) (→‎GSSHA 8.0 Official Release Version)

Jump to: navigation, search

GSSHA™ Executable Installation Downloads

GSSHA is released periodically as the model is updated with new features. Only the latest official release version is maintained along with Beta versions released on this site. While earlier release versions remain available on the site they are not supported and may not be compatible with the current version of WMS. The most current versions of the model are located at the top of the page, with older versions below. Beta versions typically appear at the very bottom of page. We strongly suggest that users start using the current release version 8.0.

GSSHA 8.0 Official Release Version

Version 8.0 of GSSHA features a major revision of the internal simulation components of GSSHA. The refactoring allows GSSHA to be modular in nature. The simulation components are now in a library. The aim of GSSHA 8.0 is to support programmatic integration of GSSHA with data, models, and modeling frameworks. GSSHA 8.0 has the simulation features refactored into a library that can be programmatically used. Further, GSSHA 8.0 supports the Basic Model Interface (BMI) and the extensions of BMI for the NextGen Modeling Framework. Check back frequently as this version will be updated regularly with new interface options for BMI access. Example projects using the GSSHA simulation library will be available soon.

On the physics side, GSSHA 8.0 has a significant update to the permafrost model. The videos from the recent training course featuring the updates to the permafrost model will soon be on the YouTube GSSHA Tutorial website (https://www.youtube.com/@gsshatutorials.)

Version 8.0.18 includes updates that include time/date conversion functionality in the library as well as a bug fix for channel velocity output data. Version 8.0.19 includes additional exposed BMI variables for index maps and contaminants.

More to come shortly!

Windows Version: GSSHA 8.0.019 with OpenMP, Windows x64. Date: December 9, 2024

Experimental Python Version

We are currently finishing up a python interface for GSSHA that will integrate with the NOAA NextGen system, which is based on BMI. This release is still being finalized. It is released here so developers and researchers can begin experimenting with it. It requires Python 3.11 or higher. It is recommended to use an virtual environment system such as Conda.

Installation instructions:

  1. Download and install the GSSHA release from above
  2. Include the path to the GSSHA release in your PATH environmental variables.
  3. (Optional) Create a python virtual environment or activate an existing one.
  4. Download the python wheel below and use PIP to install the python interface into your environment. For example "pip install gssha-0.0.1-cp311-cp311-win_amd64.whl"
  5. Copy the GSSHAlib.dll file from the GSSHA installation to the "Library\bin" folder of your python environment. For example, "copy GSSHAlib.dll "C:\Users\USERNAME\AppData\Local\anaconda3\envs\ENVIRONMENTNAME\Library\bin\GSSHAlib.dll"

Windows Python Version: GSSHAPython_0.0.1 Windows x64 Python Wheel. Date: December 9, 2024

GSSHA 7.15 Version

Version 7.15 has been updated from v7.13 with several minor bug fixes and a couple of feature enhancements.

7.15b is now the latest version. It includes bug fixes for contaminant output files and snow. It also includes a new GW_HOTSTART_OUTPUT project card to name the output aquifer elevation file (defaults to hotstart_file as was previously output).

Windows version: GSSHA 7.15b with OpenMP, Windows x64. Date: July 19, 2024


7.15a Bug fixes include lake mass balance issues, ET cloud cover and radiation bugs, OpenMP 2-layer soil moisture bug, and Havercamp mapping table issue. EXPLICIT overland mode is now deprecated and not recommended (use ADE or ADE-PC). Streams now have momentum as part of their formulation.

Windows Version: GSSHA 7.15a with OpenMP, Windows x64. Date: June 4, 2024

GSSHA 7.13 Version

Version 7.12 has been modified to fix several minor bugs with enhancement of some features. Bug fix for time varying channel boundary, 10/10/18. Bug fixes for soil moisture outputs when using groundwater 3/22/19. Bug fixes related to drainage output and parameter replacement for Richards Equation inputs. Bug fixes for RELATIVE time series, improvements for infiltration related to exfiltration and improvements for lake calculations 11/20/19.

Windows Versions:

Linux Version

GSSHA 7.12

Version 7.0 has been modified to fix lake seepage issues, and other minor issues. Updated again for lake/channel startup issues. Since Oct 2017 fixes have been put in place for subsurface drainage and the capability to put out cumulative overland flow has been added. See the project file for the new cards related to cumulative overland flow output. The previous LINUX and Windows versions were merged to create GSSHA 7.1. Since the codes are merged, future releases of LINUX/Windows versions will occur at the same time. Version 7.12 (Jan, 2018) has some improvements for overland hydrodynamics. See the new cards in Manual Chapter 3 - Project File, and a description in the Manual Chapter 5 - Surface Water Routing.

Windows Versions:

LINUX Version:

GSSHA70 - No longer supported

As of Dec 13, 2016 I'm declaring GSSHA70 the official release version. It was thoroughly vetted over the summer by my intern David Ketchum, thanks David! This version has all the latest snow advancements, the current version of the permafrost modeling, cell blocking, depth varying overland roughness, link-node subsurface routing, more checks on inputs, updated water quality modeling routines, and many other fine features. I don't think any of the inputs changed, except maybe some of the previously used snow cards may now be obsolete. As with previous versions we are still not recommending using the SNAP model for vertical transport through the snow pack.

If you encounter new and unsettling issues, let me know.

As of July 17, 2017 - just a couple of bug fixes, reading RADAR input files, stream partition coefficient, the no data flag for the ASCII map output, and the ability to read in stream hydrographs as scheduled release structures as the first link in a reach of the stream.

LINUX versions: LINUX versions should be considered "provisional" at this point because they have not undergone all the testing of the Windows versions. Check your results against the Windows official release version.

GSSHA612 - Previous Release Version - no longer supported

GSSHA612 replaced GSSHA61 and has now been replaced by GSSHA70

Version 6.12 - GSSHA for Linux - supported until GSSHA70 for LINUX is released

The following GSSHA rpm works on derivatives of Red Hat (centos, scientific linux, fedora).


For installing gssha from the rpm, download the rpm and let the package manager install it.

Release Version 3 - no longer supported

This version is no longer being updated for bugs. If you are experiencing some difficulty you think is related to the code, download a more current version and try that. Use of version 4 and higher may require changes to your input files. These changes are being incorporated into the Wiki as they occur. Note: Use of GSSHA v61 is strongly reccomended.

Release Version 4 - no longer supported

Version 4 development has ceased as of January 2009. As with Version 3, it is no longer being updated for bugs. Documentation of version 4 in the Wiki is complete. Version 4 is compatible with WMS 8.2. Note: Users should begin using v61 of GSSHA.

Release Version 5 - no longer supported

As with previous versions, v5 is no longer supported and are not supported by current version of WMS. Since file formats have changed over versions it is reccommended that the users of the older versions adopt v61 and make the required changes to their input files. This version includes significant enhancements including the ability to input hydrographs, with or without contaminants, at any point in the stream network and a version of the multi-layer G&A infiltration model that can be used in long term mode, linked with groundwater, and used in contaminant transport, including transport in the soils. The multi-layer G&A is not currently supported by WMS. This version also includes contaminant transport of constitutents attached to sediments. The sub-surface drainage with tile drains are working in this version as well. In addition, the input for the GAR infiltration model has been modified such that the wilting point value is entered in the G&A model of infiltration table and not included in the evapotranspiration table in the mapping table file. The automated calibration method has also been modified and undergone extensive testing to ensure robustness. As of Oct 2009 the automated calibration method can be used for calibration to sediment data, as well as flow data (See Chapter 18 of the manual). The most recent addition is the ability to put out maps of groundwater recharge (See Chapter 3 of the Manual). Other than the notes above GSSHA v 5.1 is generally supported by WMS v 8.4 which is currently being modified to include support for these new features. Note: in a previous version 5 (as of April 2009) the G&A infiltration method for single events was producing incorrect results, this problem has been resolved as of May 21, 2009. This problem did not affect models using GAR, multi-layer G&A, or RE solutions of infiltation. The October 2009 releases have bug fixes to the automated calibration routines. The March 2010 release has bug fixes for contaminant transport. The June 2010 release has changes related to sediment transport output files, corrects problems reading the Richards Equation mapping table, and corrects Superlink starting conditions and error flags. The October 2010 compile fixes problems with using multiple gages and for automated calibration. If you are using multiple gages in your automated calibration you should definitely switch to this or a later version of the model.

It is strongly reccomended that users of earlier versions of GSSHA and WMS switch to GSSHA v 61 and WMS v9.1.

Version 5.7 - phased into v6.0 - no longer supported

In this version we have the OpenMP parallelization working on both the 32 bit and the 64 bit version. We also have resolved many file related problems that were really only appearing during the use of the automated calibration. In addition, there have been a significant number of corrections to the in-stream sediment routing in this version of the code. If you are doing sediment transport with streams you definitely want to be using this version. There are no input changes associated with this version so it is compatible with WMS v 8.4. The programs below will install gssha571.exe on your computer. You will need to enter the command gssha57 to use this version. As of June 23, 2011 problems with running Richard's Equation in event mode have been fixed.

If you are using Windows 7 you should use the PROJECT_PATH card in your project file. The PROJECT_PATH card is used to specify the directory to put output automatically generated by GSSHA. If you use the PROJECT_PATH card, all other path names in your project file, and mapping table (.cmt) file should be relative to the PROJECT_PATH. The easiest solution is to copy the executable (gssha57.exe) to the directory with your input files and run from the command line, i.e. gssha57 project.prj. In this case, you don't need the project path card. More information about the PROJECT_PATH card can be found in Section 3.12 of the GSSHA User's Manual, available on this site. If you are using Windows 7 and have problems with this version, try version 5.1, and let me know you are having problems. Problems with automated calibration appear to be fixed as of Sept 23, 2011

Version 57sR is currently considered the release version for use with WMS 9.0+, it has mapping tables for the multi-layer G&A and new sediment transport capacity formulations and a modified mapping table. In this version SOIL_EROSION methods 3-6, have been replaced, as per the discussion in section 10.1.3 of the manual. Also, the parameters related to these methods have been removed from the mapping table (overland detachment coefficient, overland detachment exponent, and overland detachment critical value), such that the mapping table for overland sediment erosion has only 5 values, not including the sediment fractions. This version also has overland rating curve structures type 6 and 7 included,and has fixes for sediment transport in channels with structures and overbank flow, plus new overbank flow methods,

An updated version of 57sR still in testing is:

Please see Chapter 18 Section 6 for GSSHA 5.7a executables that employ four new alternate GSSHA run modes directed to providing additional capabilities for the computer-based calibration of a GSSHA model deployment

Special versions

For Jaime

Version 6.0 - phased into v61 - no longer supported

This version contains all the updates to version 5 plus new snow accumulation, melt, and routing methods. If you are using prior versions, especially if you are using special pre-release versions, you should switch to v61. GSSHA 5, 5.1, 5.7, 57sR, etc., will no longer be supported. As we are moving toward v61 this version is only being updated for known bugs. These bugs fixes, and new capability, are included in v61. v61 is considered Beta, but is really more pre-release and should become the release version soon.

GSSHA 60 is compatible with WMS 9.0+, however some of the new features are not yet supported in WMS, including the new calibration methods, overland hydraulic structures, multi-layer Green and Ampt inputs, and a some of the latest snow features. See discussion on version 5.7 above for more details.

Please see Chapter 18 Section 6 for GSSHA 5.7a executables that employ four new alternate GSSHA run modes directed to providing additional capabilities for the computer-based calibration of a GSSHA model deployment.

Additional information on the new snow features is forthcoming.

Notes: GSSHA60 releases prior to Jan 30, 2013 had errors related to static overland head boundaries. All GSSHA versions prior to Jan 30, 2013 are subject to errors when simulating multiple lakes in the same model. Errors related to initilizaing a model with SWE are fixed as of 5-13-2013. Additional bugs fixed as 7-31-2013 including fixes to the GAR infiltration routine. Note that simulation results using GAR will differ (more infiltration) compared to previous results.

Version 6.1 - Replaced with final 6.1 v 6.12 - No longer supported

This version has depth varying overland roughness and the ability to assign overbank flow and backwater calculations to individual stream links. There are also static lakes and lakes with defined rating curves. Additional, overland structures can be used to pass water through embankments, including between lakes. There are also some modifications to the storm and tile drains routines. Lakes and groundwater have been made OPM parallel. Snow accumulation, melting, and overland routing through the snow pack have also been updated in this version. In this version the inflection points in the ET and interception routines can now be user selected. Additional bug fixes, including the one for GAR noted above, are also included. This version includes everything in all previous 6.0 or 6.1 special versions. Recent bug fixes include the Continuous Frozen Ground Index (CFGI) model Nov 13,2013 and non-interpolated specified overland boundary conditions. It should be noted that the implementation of the SNAP model for meltwater routing through the snowpack, both vetically and horizontally, is considered experimental, and is not reccomended for use at this time.

If you have been using one of those versions you should switch to this one. I have permanently removed those versions. Some of the information for the new features have not been updated. If you need examples of input files for new features contact me.

As of Nov 27 I fixed bug related to radiation calculations. If you have been getting an on screen error about the ground temperature not converging, this will likely resolve that. Changes to default DALR values, Dec 4, 2013. Minor fixes for lakes, Jan 17, 2014. Fix for the Continuous Frozen Ground Index model, Feb 7, 2014. Fix for time varying overland flow point depth boundary conditions, Feb 24, 2014. Increased precision for the OPTIMIZE_SED output, 3-13-14. March 31, 2014 updated method for SUPERLINK_C_OPT. If you are using superlinks and having to use small overall time step to maintain mass balance, adding the SUPERLINK_C_OPT should allow you to increase your model timestep without mass balance problems. The decrease in simulation time is dependent on how the size of your superlinks network. The speedup is primarily in the other processes. If you superlinks network is accounting for most of the simulation time then the speed up will be minimal. Just add the SUPERLINK_C_OPT card to your current project file. I would be curious to know your experiences with this if you are using superlink networks. April 24, 2014 - minor changes to the superlink model. May 8 2014, minor changes to the superlink model. Oct 9, 2014 - Problems with the parameter replacement functionality were identified and corrected. This was affecting any GSSHA utility that uses the replacement functionality, including batch runs, Monte Carlo runs, SCE calibration and SLM calibration.

Version 6.2 - Beta - no longer supported

GSSHA version 6.2 was the beta version of GSSHA 70, which has been released as of Dec 13, 2016. Users of v62 should begin using version 70, if they have not already begun doing so.

New features in 6.2 are related to snow accumulation, melt, and frozen soil simulation. These have been active research topics in the last two years and the methods implemented in the model have been evolving. Users interested in using the latest snow and frozen soil formulations in GSSHA may be interested in trying this Beta release. Primary changes in snow modeling involve changes to the radiation calculations, changes to how water travels through the snow pack and how it is delivered to the overland. There have also been some modifications to the overland routing through the snow pack. Overland routing with snow on the surface is an area of active research and the methods deployed in the model continue to evolve. It should be noted that the implementation of the SNAP model in GSSHA for routing of meltwater through the snow pack (both vertically and horizontally) is considered experimental at this time and it's use is not reccomended for this purpose. Additional information can be found in Section 9.4 of the Users Manual.

Users are referred to Section 9.4 of the Users Manual for more information about the various snow accumulation and melting options and methods. Users are referred to Section 20 - Frozen Soil for more information about the frozen soil options available in this and previous versions.

As of Nov 27, 2013 I've fixed a bug related to radiation calculations. If you have been seeing on screen errors about the ground temperature not converging, this will likely resolve that. As of Dec 4, I've modified some of the default values for DARL.

As of Jan 17 some minor changes to lakes and also the frozen soil simulations.

Updated Jan 13, 2015 includes snow interception by plants. Also includes all features previously in the v62 Special Beta (such as shading effects), which has been removed from the web site.

Removed Dec 13, 2016. End of this version.

Experimental Versions

GSSHA 7.14 Beta This version has the momentum formulation of flow used in the overland flow routines in v7.13 implemented for the channel, and has also exposed the time step limitation factor, alpha, for both overland flow and channel flow.

To use the overland flow momentum formulation use the card OVERLAND_MOMENTUM. To specify the coefficient for time step control, specify a value between 0.0 and 1.0 after the card. The default value, if none specified, is 0.2. Increase for speed, decrease for stability.

To use the channel flow momentum formulation use the card CHANNEL_MOMENTUM. To specify the coefficient for time step control, specify a value between 0.0 and 1.0 after the card. The default value, if none specified, is 0.2. Increase for speed, decrease for stability. 

* GSSHA™ 7.14 Windows 64-bit installation with OpenMp. Date: April 26, 2019

This is version 7.0 with separate partition coefficients specified for the channel and the overland. Be use to use the updated .cmt file format, example below.

.

Example of constituent mapping table file with separate partitions coefficients for overland and channel.
Notice new cards OV_PARTITION and CHAN_PARTITION have replaced single PARTITION.

.

CONTAMINANT_TRANSPORT
NUM_CONTAM     2
"Contaminant #1" "Index Map - 1" "Nitrogen"
PRECIP_CONC      0.0
OV_PARTITION      0.01
CHAN_PARTITION      0.01
NUM_IDS    1
ID      DESCRIPTION1      DESCRIPTION2      DISPERSION      DECAY      UPTAKE      LOADING      GW_CONC INIT_CONC      SW_PART      SOLUBILITY
1      Contaminant One       SOIL One               0.000000      0.00000      0.00001      1000.000000 0.0      0.0      0.01      360000.0
"Contaminant #2" "Index Map - 1" "Phosphorous"
PRECIP_CONC      0.0
OV_PARTITION        30.0
CHAN_PARTITION   3000.0
NUM_IDS 1
ID   DESCRIPTION1      DESCRIPTION2      DISPERSION      DECAY      UPTAKE      LOADING      GW_CONC INIT_CONC      SW_PART      SOLUBILITY
1      Contaminant One      SOIL ONE               0.000000      0.00000      0.00001      1000.000000      0.0      0.0      30      220000

Watershed Modeling System

For Corps users, a copy of the WMS software can be obtained on the CHL web site. A license and password to use WMS can be obtained by following the instructions on the site.

For non-Corps users, a licensed copy of the WMS software can be obtained from the Aquaveo web site.

The WMS wiki can be found here.

WMS 8.1 interfaces with GSSHA™ 3.0b. WMS 8.2 interfaces with GSSHA™ 4.0 and WMS 8.4 interfaces with GSSHA™ 5 . WMS 9.0 interfaces with GSSHA™ 5.1 and WMS 9.1 interfaces with GSSHA™ 6 .

Tutorial Files

Logos

Retrieved from "https://gsshawiki.com/index.php?title=GSSHA_Download&oldid=6564"