-
Notifications
You must be signed in to change notification settings - Fork 22
ASGS Cheat Sheet
wwlwpd edited this page Jul 23, 2022
·
21 revisions
Installation and Updating (commands issued in login shell)
| For this | Do this | Notes |
|---|---|---|
| Prepare for Installation | login to Github account (required); upload an ssh key for authentication | This step is not required for running ASGS, but is highly recommended for set up and maintenance |
| Get ASGS from Github | git clone [email protected]:StormSurgeLive/asgs.git |
needs ssh keys |
| Install ASGS | cd /path/to/asgs; ./init-asgs.sh |
starts an interactive “wizard”; build takes a while (grab a cup of joe) |
| Update asgsh shell | `git pull origin master; ./update-asgsh --update-shell | assumes pwd is asgs/ and the git branch is master
|
| Update Python and modules* *Note: this consists of 2 commands | update-asgsh --run-steps python --clean &&\ # removes python and modulesupdate-asgsh --run-steps python # installs python 2.7.18 and modules | |
| Update all Perl and modules | update-asgsh --run-steps perl --clean &&\ # removes perl and modulesupdate-asgsh --run-steps perl,perl-modules # installs perl 5.32.0 and modules | |
| List available “steps” | update-asgsh --list-steps | |
| Uninstall Everything*(*except ADCIRC) | update-asgsh –-clean | |
| For this | Do this | |
| Start ASGS Shell (in login shell) | asgsh [-h ] | [-x][-d] [ -p PROFILE-NAME] |
| Install ADCIRC (interactive) | asgs (default)> build adcirc # requires access to ADCIRC GitHub repo | |
| Verify environment | asgs (default)> verify # run 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 adcirc [] # sets envar ADCIRCDIR | |
| Define Config | asgs (default)> define config /abspath/to/asgs-config-file | |
| Save Profile | asgs (default)> save profile PROFILE-NAME # e.g., stormName2020 | |
| Clone Profile (interactive) | asgs (default)> clone profile # define config first | |
| Rebuild Profile (interactive) | asgs (default)> rebuild profile # prompts for path to existing config file | |
| See aliases (not in help) | asgs (default)> alias -p | |
| Operational | Commands | |
| Load Profile | asgs (default)> load profile PROFILE-NAME | |
| Edit Config | asgs (PROFILE-NAME)> edit config | |
| Run ASGS (req. set config) | 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 syslog # in another terminal | |
| Save Profile | asgs (PROFILE-NAME)> save profile PROFILE-NAME |