ASGS Shell Environment Quick Reference 1.6 This document is best viewed on a wide screen, without the side
bar listing all the docs in the wiki. This guide may also be cloned
locally, within asgsh using the fetch docs command:
asgs (default)> fetch docs
asgs (default)> vim git/asgs.wiki/ASGS-Cheat-Sheet.md
The following tables generally tracks one's needs at the go about
setting up ASGS for the first time; then subsequently as one uses
ASGS. Please let us know what's missing and we will gladly add it.
Installation and Updating (commands issued in login shell)
For this
Do this
Notes
Prepare for Installation
login to Github account; upload an ssh key
not required, highly recommended for set up and maintenance
Get ASGS from Github
git clone [email protected] :StormSurgeLive/asgs.gitneeds ssh keys
Install ASGS
cd /path/to/asgs; ./init-asgs.shstarts an interactive “wizard”; build takes a while (grab a cup of joe)
Install ASGS + local path
cd /path/to/asgs; ./init-asgs-sh -p path/to/assetspoints init-asgs.sh to a path containing local assets (platform info, etc)
Update asgsh shell
git pull origin master; ./update-asgsh --update-shellassumes pwd is asgs/ and the git branch is master
List available “steps”
./update-asgsh "--list-steps"quoting flags are needed for all flags passed to asgs-brew.pl
Run a specific "step"
./update-asgsh "--run-steps stepA,stepB,etc.."multiple steps are comma-delimited without spaces
Uninstall Everything
./update-asgsh "--clean"
Clean specific "steps"
./update-asgsh "--run-steps stepA,stepB --clean"runs "--clean" for steps specified by "--run-steps"
ASGS Interactive Shell Environment
For this
Do this
Notes
Start ASGS Shell
asgsh[-h] [-x][-d] [ -p PROFILE-NAME]
Install ADCIRC
asgs (default)> build adcircrequires access to ADCIRC GitHub repo
Verify environment
asgs (default)> verifyrun after install or updates
List Profiles
asgs (default)> list profiles
Load Profile
asgs (default)> load profile PROFILE-NAME
List ADCIRCs
asgs (default)> list adcirc
Load ADCIRC
asgs (default)> load adcircsets envar ADCIRCDIR
Define Config
asgs (default)> define config to/asgs-config-file
Save Profile
asgs (default)> save profile PROFILE-NAME
Clone Profile
asgs (default)> clone profile
Rebuild Profile
asgs (default)> rebuild profileprompts for path to existing config file
See aliases (not in help)
asgs (default)> alias -p
Realtime Operator Workflows & Tricks
For this
Do this
Notes
Download common git repo
asgs (default) fetch <repo-name>e.g.,fetch docs will put the wiki repo into $SCRIPTDIR/git/asgs.wiki
Load Profile
asgs (default)> load profile PROFILE-NAME
Import Profile
`asgs (default)> rebuild profile path/to/myconfig.sh
completion for finding files is supported in this command
Check Config for Errors
asgs (PROFILE-NAME) asgs-lintyou must load a profile first, command is silent if no errors are found
Edit Config
asgs (PROFILE-NAME)> edit config
Run ASGS
asgs (PROFILE-NAME)> run
cd to scratch
asgs (PROFILE-NAME)> goto scratchdir
s is an alias
cd to scriptdir
asgs (PROFILE-NAME)> goto scriptdir
sd is an alias
tail ASGS system log
asgs (PROFILE-NAME)> tailf syslogin another terminal
Save Profile
asgs (PROFILE-NAME)> save profile PROFILE-NAME
Verify Set Up
asgs (default)> verify
Verify Email
asgs (default)> verify email [email protected] inspects ~/asgs-global.conf, if correct attempts to email the address