diff --git a/etc/matlab/README.md b/etc/matlab/README.md new file mode 100644 index 0000000000000000000000000000000000000000..232b7be888978cdb4bb69bc793159e8c9f78668d --- /dev/null +++ b/etc/matlab/README.md @@ -0,0 +1,10 @@ +Using nshmp-haz with Matlab +--------------------------- + +All recent versions of Matlab include a Java runtime environment and it is therefore relatively straightforward to access the nshmp-haz library. + +#### Requirements + +* Matlab R2013B or higher (nshmp-haz targets Java 7; prior versions of Matlab use Java 6). +* A [build](/usgs/nshmp-haz/wiki/Building-&-Running) of nshmp-haz. +* \ No newline at end of file diff --git a/etc/matlab/gmmExample.m b/etc/matlab/gmmExample.m index 0897bbf5077b220d57db1c825f8ce796f094c743..25083755a503bc4007e8333624a40ba8b0e85a44 100644 --- a/etc/matlab/gmmExample.m +++ b/etc/matlab/gmmExample.m @@ -1,14 +1,14 @@ -%% nshmp-sha Ground Motion Model explanatory script +%% nshmp-haz Ground Motion Model (GMM) explanatory script % ========================================================================= -% This script describes how to access the ground motion models implemented -% in the nshmp-sha hazard codes. The models are written in Java and require -% little more than to be identified to Matlab to function properly. +% This script provides instruction on how to access the ground motion models +% implemented in the nshmp-haz library. The models are written in Java and +% require little more than to be identified to Matlab to function properly. % ========================================================================= % Set up: -% (Required) Have the nshmp-sha project cloned somewhere local. The +% (Required) Have the nshmp-haz project cloned somewhere local. The % instructions below that the project has also been compiled such % that a 'classes' directory exsists.