Merge branch 'main' of github.com:TACC/TACC-Docs

TACC · Oct 2, 2024 · 7a119c6 · 7a119c6
2 parents bb30a0c + f6b755b
commit 7a119c6
Show file tree

Hide file tree

Showing 5 changed files with 30 additions and 24 deletions.
diff --git a/docs/aliases.md b/docs/aliases.md
@@ -12,16 +12,16 @@
 
 [TACCANALYSISPORTAL]: http://tap.tacc.utexas.edu "TACC Analysis Portal"
 
-[TACCLMOD]: https://lmod.readthedocs.io/en/latest/ "Lmod"
 [DOWNLOADCYBERDUCK]: https://cyberduck.io/download/ "Download Cyberduck"
 
 
+[TACCLMOD]: https://lmod.readthedocs.io/en/latest/ "Lmod"
 [TACCREMOTEDESKTOPACCESS]: https://docs.tacc.utexas.edu/tutorials/remotedesktopaccess "TACC Remote Desktop Access"
 [TACCSHARINGPROJECTFILES]: https://docs.tacc.utexas.edu/tutorials/sharingprojectfiles "Sharing Project Files"
 [TACCBASHQUICKSTART]: https://docs.tacc.utexas.edu/tutorials/bashstartup "Bash Quick Start Guide"
 [TACCACCESSCONTROLLISTS]: https://docs.tacc.utexas.edu/tutorials/acls "Access Control Lists"
 [TACCMFA]: https://docs.tacc.utexas.edu/basics/mfa "Multi-Factor Authentication at TACC"
 [TACCIDEV]: https://docs.tacc.utexas.edu/software/idev "idev at TACC"
-[TACCSOFTWARE]: https://tacc.utexas.edu/use-tacc/software-list/ "Software List""
 
+[TACCSOFTWARELIST]: https://tacc.utexas.edu/use-tacc/software-list/ "Software List""
 [TACCSOFTWARE]: https://docs.tacc.utexas.edu/basics/software/ "Software at TACC"
diff --git a/docs/basics/software.md b/docs/basics/software.md
@@ -1,25 +1,22 @@
 # Software at TACC
+Last update: *September 30, 2024*
 
-## System-Installed 
-
-!!! tip
-	TACC maintains a large list of currently installed software on all HPC resources: Lonestar6, Frontera, Stampede3 and Vista.  Navigate TACC's [Software List][TACCSOFTWARE] to see where, or if, a particular package is already installed.
-
+*This document is in progress*.
 
+## System-Installed 
 
-## Managing your environment with Lmod
-
-All software package management at TACC is done with the [TACC's Lmod tool][TACCLMOD].
+TACC maintains a large [list of currently installed software][TACCSOFTWARELIST] on all HPC resources: Lonestar6, Frontera, Stampede3 and Vista.  
 
-## Software not installed
+!!!tip
+	Navigate TACC's [Software List][TACCSOFTWARE] to see where, or if, a particular package is already installed on a particular resource.
 
-Submit a ticket, or install your own.
+If the software search results are inconclusive you have two choices:
 
-### Building Software
+1. Request TACC staff make a global, system-wide, installation of your software package
+1. Install the software package in your own directory.  You can always make the executable available to project members.
 
-!!! tip 
-	On occasion you'll see installation documentation mention the need for `sudo`, but in almost all cases that is because the assumption is that the installation is intended to be across the entire machine. Instead, for the packages and/or dependencies the process would be the same: import/transfer source materials, extract, and build. 
 
+### Resource-Specific Build Instructions
 
 See each resource user guide's Building Software and Performance sections for architecture-specific build instructions:
 
@@ -69,9 +66,9 @@ $ pip install netCDF4     --prefix=$INSTALLDIR      # custom location; add to PY
 Similarly in R:
 
 ```cmd-line
-$ module load Rstats            # load TACC's default R
-$ R                             # launch R
-> install.packages('devtools')  # R will prompt for install location
+$ module load Rstats                                # load TACC's default R
+$ R                                                 # launch R
+> install.packages('devtools')                      # R will prompt for install location
 ```
 
 You may, of course, need to customize the build process in other ways. It's likely, for example, that you'll need to edit a makefile or other build artifacts to specify resource-specific include and library paths or other compiler settings. A good way to proceed is to write a shell script that implements the entire process: definitions of environment variables, module commands, and calls to the build utilities. Include echo statements with appropriate diagnostics. Run the script until you encounter an error. Research and fix the current problem. Document your experience in the script itself; including dead-ends, alternatives, and lessons learned. Re-run the script to get to the next error, then repeat until done. When you're finished, you'll have a repeatable process that you can archive until it's time to update the software or move to a new machine.
@@ -80,3 +77,12 @@ If you wish to share a software package with collaborators, you may need to modi
 
 
 {% include 'aliases.md' %}
+
+<!--
+!!! tip 
+	On occasion you'll see installation documentation mention the need for `sudo`, but in almost all cases that is because the assumption is that the installation is intended to be across the entire machine. Instead, for the packages and/or dependencies the process would be the same: import/transfer source materials, extract, and build. 
+
+!!!tip
+	All software package management at TACC is done with the [TACC's Lmod tool][TACCLMOD].
+
+-->
diff --git a/docs/hpc/lonestar6.md b/docs/hpc/lonestar6.md
@@ -1414,16 +1414,16 @@ TACC Consulting operates from 8am to 5pm CST, Monday through Friday, except for
 
 [TACCANALYSISPORTAL]: http://tap.tacc.utexas.edu "TACC Analysis Portal"
 
-[TACCLMOD]: https://lmod.readthedocs.io/en/latest/ "Lmod"
 [DOWNLOADCYBERDUCK]: https://cyberduck.io/download/ "Download Cyberduck"
 
 
+[TACCLMOD]: https://lmod.readthedocs.io/en/latest/ "Lmod"
 [TACCREMOTEDESKTOPACCESS]: https://docs.tacc.utexas.edu/tutorials/remotedesktopaccess "TACC Remote Desktop Access"
 [TACCSHARINGPROJECTFILES]: https://docs.tacc.utexas.edu/tutorials/sharingprojectfiles "Sharing Project Files"
 [TACCBASHQUICKSTART]: https://docs.tacc.utexas.edu/tutorials/bashstartup "Bash Quick Start Guide"
 [TACCACCESSCONTROLLISTS]: https://docs.tacc.utexas.edu/tutorials/acls "Access Control Lists"
 [TACCMFA]: https://docs.tacc.utexas.edu/basics/mfa "Multi-Factor Authentication at TACC"
 [TACCIDEV]: https://docs.tacc.utexas.edu/software/idev "idev at TACC"
-[TACCSOFTWARE]: https://tacc.utexas.edu/use-tacc/software-list/ "Software List""
 
+[TACCSOFTWARELIST]: https://tacc.utexas.edu/use-tacc/software-list/ "Software List""
 [TACCSOFTWARE]: https://docs.tacc.utexas.edu/basics/software/ "Software at TACC"
diff --git a/docs/hpc/stampede3.md b/docs/hpc/stampede3.md
@@ -1846,16 +1846,16 @@ TACC Consulting operates from 8am to 5pm CST, Monday through Friday, except for
 
 [TACCANALYSISPORTAL]: http://tap.tacc.utexas.edu "TACC Analysis Portal"
 
-[TACCLMOD]: https://lmod.readthedocs.io/en/latest/ "Lmod"
 [DOWNLOADCYBERDUCK]: https://cyberduck.io/download/ "Download Cyberduck"
 
 
+[TACCLMOD]: https://lmod.readthedocs.io/en/latest/ "Lmod"
 [TACCREMOTEDESKTOPACCESS]: https://docs.tacc.utexas.edu/tutorials/remotedesktopaccess "TACC Remote Desktop Access"
 [TACCSHARINGPROJECTFILES]: https://docs.tacc.utexas.edu/tutorials/sharingprojectfiles "Sharing Project Files"
 [TACCBASHQUICKSTART]: https://docs.tacc.utexas.edu/tutorials/bashstartup "Bash Quick Start Guide"
 [TACCACCESSCONTROLLISTS]: https://docs.tacc.utexas.edu/tutorials/acls "Access Control Lists"
 [TACCMFA]: https://docs.tacc.utexas.edu/basics/mfa "Multi-Factor Authentication at TACC"
 [TACCIDEV]: https://docs.tacc.utexas.edu/software/idev "idev at TACC"
-[TACCSOFTWARE]: https://tacc.utexas.edu/use-tacc/software-list/ "Software List""
 
+[TACCSOFTWARELIST]: https://tacc.utexas.edu/use-tacc/software-list/ "Software List""
 [TACCSOFTWARE]: https://docs.tacc.utexas.edu/basics/software/ "Software at TACC"
diff --git a/docs/hpc/vista.md b/docs/hpc/vista.md
@@ -740,16 +740,16 @@ TACC Consulting operates from 8am to 5pm CST, Monday through Friday, except for
 
 [TACCANALYSISPORTAL]: http://tap.tacc.utexas.edu "TACC Analysis Portal"
 
-[TACCLMOD]: https://lmod.readthedocs.io/en/latest/ "Lmod"
 [DOWNLOADCYBERDUCK]: https://cyberduck.io/download/ "Download Cyberduck"
 
 
+[TACCLMOD]: https://lmod.readthedocs.io/en/latest/ "Lmod"
 [TACCREMOTEDESKTOPACCESS]: https://docs.tacc.utexas.edu/tutorials/remotedesktopaccess "TACC Remote Desktop Access"
 [TACCSHARINGPROJECTFILES]: https://docs.tacc.utexas.edu/tutorials/sharingprojectfiles "Sharing Project Files"
 [TACCBASHQUICKSTART]: https://docs.tacc.utexas.edu/tutorials/bashstartup "Bash Quick Start Guide"
 [TACCACCESSCONTROLLISTS]: https://docs.tacc.utexas.edu/tutorials/acls "Access Control Lists"
 [TACCMFA]: https://docs.tacc.utexas.edu/basics/mfa "Multi-Factor Authentication at TACC"
 [TACCIDEV]: https://docs.tacc.utexas.edu/software/idev "idev at TACC"
-[TACCSOFTWARE]: https://tacc.utexas.edu/use-tacc/software-list/ "Software List""
 
+[TACCSOFTWARELIST]: https://tacc.utexas.edu/use-tacc/software-list/ "Software List""
 [TACCSOFTWARE]: https://docs.tacc.utexas.edu/basics/software/ "Software at TACC"