Difference between revisions of "UFRC environment module"

From UFRC
Jump to navigation Jump to search
(2 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
[[Category:Software]]
 
[[Category:Software]]
−
A number of useful tools - both external or internal - is provided via the '<code>ufrc</code>' environment module. Load with '<code>module load ufrc</code>'. The following is a short summary of the available tools presented in alphabetical order:
+
A number of useful tools - both external or internal - is provided via the '<code>ufrc</code>' environment module which is loaded automatically at login. It can be reloaded with '<code>module load ufrc</code>'. The following is a short summary of the available tools presented in alphabetical order:
  
−
* black - python3-based [https://github.com/ambv/black uncompromising python code formatter].
+
{| class="wikitable"
−
* blue_quota - show HiPerGator Blue Storage (/blue) quota usage for your user and group.
+
|-
−
* dos2unix - [http://dos2unix.sourceforge.net/dos2unix.htm convert line endings] in text files between linux, windows, and macos formats.
+
! Header Name !! Header Description
−
* filan - [https://www.unix.com/man-page/debian/1/filan/ print active file descriptors to stdout].
+
|-
−
* findnewest - shell script to  showing the most recent modified files in the argument directory.
+
| black || python3-based [https://github.com/ambv/black uncompromising python code formatter].
−
* home_quota - show your HiPerGator Home directory quota usage.
+
|-
−
* htop - [https://hisham.hm/htop/ interactive process viewer].
+
| blue_quota || show HiPerGator Blue Storage (/blue) quota usage for your user and group.
−
* lftp - [https://lftp.yar.ru/ sophisticated file transfer program supporting ftp, http, sftp, fish, and torrent].
+
|-
−
* jobhtop (jobps alias) - real-time display of ''job'' processes using the [https://hisham.hm/htop/ htop tool].
+
| dos2unix || [http://dos2unix.sourceforge.net/dos2unix.htm convert line endings] in text files between linux, windows, and macos formats.
−
* jobnvtop - real-time display of ''job'' GPU usage and processes using the [https://github.com/Syllo/nvtop nvtop tool].
+
|-
−
* mac2unix - a wrapper of dos2unix preset for conversion from macos to linux text file line endings.
+
| filan || [https://www.unix.com/man-page/debian/1/filan/ print active file descriptors to stdout].
−
* nc - [http://man7.org/linux/man-pages/man1/ncat.1.html concatenate and redirect sockets].
+
|-
−
* ncat - [https://nmap.org/ncat modern nmap rewrite of netcat].
+
| findnewest || shell script to  showing the most recent modified files in the argument directory.
−
* ncdu - [https://dev.yorhel.nl/ncdu terminal 'gui' for showing directory sizes].
+
|-
−
* nodeInfo - show HiPerGator node types and capacities.
+
| getentng || our replacement for the linux getent tool to show user and group information.
−
* orange_quota - show HiPerGator Orange Storage (/orange) quota usage for your project(s).
+
|-
−
* pbs_to_slurm - convert an old Torque-based job script to SLURM format.
+
| home_quota || show your HiPerGator Home directory quota usage.
−
* procan - [https://github.com/matburt/procan an adaptive process analysis tool].
+
|-
−
* pytest - Run a python test suite if present in the current directory tree.
+
| htop || [https://hisham.hm/htop/ interactive process viewer].
−
* qos_to_burst - move a pending job with the specified id to the burst QOS.
+
|-
−
* qos_to_main - move a pending job with the specified id to the investment QOS.
+
| lftp || [https://lftp.yar.ru/ sophisticated file transfer program supporting ftp, http, sftp, fish, and torrent].
−
* relative_path - show relative path starting from the specified optional path.
+
|-
−
* shellcheck - check the syntax of your shell script or job script.
+
| jobhtop (jobps alias) || real-time display of ''job'' processes using the [https://hisham.hm/htop/ htop tool].
−
* showAssoc - show your SLURM account associations.
+
|-
−
* showQos - show your SLURM investment QOS limits.
+
| jobnvtop || real-time display of ''job'' GPU usage and processes using the [https://github.com/Syllo/nvtop nvtop tool].
−
* showstart - show when the job with the specified id started.
+
|-
−
* slurm_exit_info - show SLURM exit code for a job with the specified id.
+
| mac2unix || a wrapper of dos2unix preset for conversion from macos to linux text file line endings.
−
* slurmInfo - show information about SLURM allocation as well as running and pending jobs for a SLURM account.
+
|-
−
* socat - [https://linux.die.net/man/1/socat multipurpose relay] utility.
+
| nc || [http://man7.org/linux/man-pages/man1/ncat.1.html concatenate and redirect sockets].
−
* squeueall - show all jobs in SLURM queue.
+
|-
−
* squeuemine - show SLURM jobs for your user id.
+
| ncat || [https://nmap.org/ncat modern nmap rewrite of netcat].
−
* squeue_pending - show sum of resources requested by all pending SLURM jobs.
+
|-
−
* srundev - start an interactive SLURM session on a development/testing node.
+
| ncdu || [https://dev.yorhel.nl/ncdu terminal 'gui' for showing directory sizes].
−
* srungui - start an interactive SLURM session on a gui node.
+
|-
−
* sruni - start an interactive SLURM session on a compute node.
+
| nodeInfo || show HiPerGator node types and capacities.
−
* srunteach - start a minimal interactive SLURM session without delay.
+
|-
−
* tree - [https://linux.die.net/man/1/tree list contents of directories in a tree format].
+
| orange_quota || show HiPerGator Orange Storage (/orange) quota usage for your project(s).
−
* unix2dos - a wrapper of dos2unix preset for conversion from linux to windows text file line endings.
+
|-
−
* unix2mac - a wrapper of dos2unix preset for conversion from linux to macos text file line endings.
+
| pbs_to_slurm || convert an old Torque-based job script to SLURM format.
−
* xeyes - simple gui program for testing whether X11 forwarding is working.
+
|-
 +
| procan || [https://github.com/matburt/procan an adaptive process analysis tool].
 +
|-
 +
| pytest || Run a python test suite if present in the current directory tree.
 +
|-
 +
| qos_to_burst || move a pending job with the specified id to the burst QOS.
 +
|-
 +
| qos_to_main || move a pending job with the specified id to the investment QOS.
 +
|-
 +
| relative_path || show relative path starting from the specified optional path.
 +
|-
 +
| shellcheck || check the syntax of your shell script or job script.
 +
|-
 +
| showAssoc || show your SLURM account associations.
 +
|-
 +
| showQos || show your SLURM investment QOS limits.
 +
|-
 +
| showstart || show when the job with the specified id started.
 +
|-
 +
| slurm_exit_info || show SLURM exit code for a job with the specified id.
 +
|-
 +
| slurmInfo || show information about SLURM allocation as well as running and pending jobs for a SLURM account.
 +
|-
 +
| socat || [https://linux.die.net/man/1/socat multipurpose relay] utility.
 +
|-
 +
| squeueall || show all jobs in SLURM queue.
 +
|-
 +
| squeuemine || show SLURM jobs for your user id.
 +
|-
 +
| squeue_pending || show sum of resources requested by all pending SLURM jobs.
 +
|-
 +
| srundev || start an interactive SLURM session on a development/testing node.
 +
|-
 +
| srungui || start an interactive SLURM session on a gui node.
 +
|-
 +
| sruni || start an interactive SLURM session on a compute node.
 +
|-
 +
| srunteach || start a minimal interactive SLURM session without delay.
 +
|-
 +
| tree || [https://linux.die.net/man/1/tree list contents of directories in a tree format].
 +
|-
 +
| unix2dos || a wrapper of dos2unix preset for conversion from linux to windows text file line endings.
 +
|-
 +
| unix2mac || a wrapper of dos2unix preset for conversion from linux to macos text file line endings.
 +
|-
 +
| xeyes || simple gui program for testing whether X11 forwarding is working.
 +
|}

Revision as of 19:37, 6 June 2022

A number of useful tools - both external or internal - is provided via the 'ufrc' environment module which is loaded automatically at login. It can be reloaded with 'module load ufrc'. The following is a short summary of the available tools presented in alphabetical order:

Header Name Header Description
black python3-based uncompromising python code formatter.
blue_quota show HiPerGator Blue Storage (/blue) quota usage for your user and group.
dos2unix convert line endings in text files between linux, windows, and macos formats.
filan print active file descriptors to stdout.
findnewest shell script to showing the most recent modified files in the argument directory.
getentng our replacement for the linux getent tool to show user and group information.
home_quota show your HiPerGator Home directory quota usage.
htop interactive process viewer.
lftp sophisticated file transfer program supporting ftp, http, sftp, fish, and torrent.
jobhtop (jobps alias) real-time display of job processes using the htop tool.
jobnvtop real-time display of job GPU usage and processes using the nvtop tool.
mac2unix a wrapper of dos2unix preset for conversion from macos to linux text file line endings.
nc concatenate and redirect sockets.
ncat modern nmap rewrite of netcat.
ncdu terminal 'gui' for showing directory sizes.
nodeInfo show HiPerGator node types and capacities.
orange_quota show HiPerGator Orange Storage (/orange) quota usage for your project(s).
pbs_to_slurm convert an old Torque-based job script to SLURM format.
procan an adaptive process analysis tool.
pytest Run a python test suite if present in the current directory tree.
qos_to_burst move a pending job with the specified id to the burst QOS.
qos_to_main move a pending job with the specified id to the investment QOS.
relative_path show relative path starting from the specified optional path.
shellcheck check the syntax of your shell script or job script.
showAssoc show your SLURM account associations.
showQos show your SLURM investment QOS limits.
showstart show when the job with the specified id started.
slurm_exit_info show SLURM exit code for a job with the specified id.
slurmInfo show information about SLURM allocation as well as running and pending jobs for a SLURM account.
socat multipurpose relay utility.
squeueall show all jobs in SLURM queue.
squeuemine show SLURM jobs for your user id.
squeue_pending show sum of resources requested by all pending SLURM jobs.
srundev start an interactive SLURM session on a development/testing node.
srungui start an interactive SLURM session on a gui node.
sruni start an interactive SLURM session on a compute node.
srunteach start a minimal interactive SLURM session without delay.
tree list contents of directories in a tree format.
unix2dos a wrapper of dos2unix preset for conversion from linux to windows text file line endings.
unix2mac a wrapper of dos2unix preset for conversion from linux to macos text file line endings.
xeyes simple gui program for testing whether X11 forwarding is working.
Retrieved from "https://help.rc.ufl.edu/mediawiki/index.php?title=UFRC_environment_module&oldid=23527"