{"id":13733043,"url":"https://github.com/ubccr/stubl","last_synced_at":"2025-08-24T10:18:02.515Z","repository":{"id":37788748,"uuid":"21871378","full_name":"ubccr/stubl","owner":"ubccr","description":"SLURM Tools and UBiLities","archived":false,"fork":false,"pushed_at":"2022-08-01T18:05:28.000Z","size":168,"stargazers_count":71,"open_issues_count":6,"forks_count":17,"subscribers_count":12,"default_branch":"master","last_synced_at":"2025-06-20T23:04:36.711Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ubccr.png","metadata":{"files":{"readme":"README.rst","changelog":"ChangeLog.rst","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2014-07-15T18:38:54.000Z","updated_at":"2025-06-18T01:19:11.000Z","dependencies_parsed_at":"2022-07-29T03:18:04.115Z","dependency_job_id":null,"html_url":"https://github.com/ubccr/stubl","commit_stats":null,"previous_names":[],"tags_count":10,"template":false,"template_full_name":null,"purl":"pkg:github/ubccr/stubl","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ubccr%2Fstubl","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ubccr%2Fstubl/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ubccr%2Fstubl/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ubccr%2Fstubl/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ubccr","download_url":"https://codeload.github.com/ubccr/stubl/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ubccr%2Fstubl/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":261032036,"owners_count":23100048,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-08-03T03:00:37.051Z","updated_at":"2025-06-20T23:06:34.231Z","avatar_url":"https://github.com/ubccr.png","language":"Shell","funding_links":[],"categories":["SLURM wrappers and libraries"],"sub_categories":[],"readme":"=============================================================================\nSTUBL - SLURM Tools and UBiLities\n=============================================================================\n\nSTUBL is a collection of supplemental tools and utility scripts for `SLURM\n\u003chttp://slurm.schedmd.com/\u003e`_. \n\n.. image:: docs/stubl_thumb.gif\n\n-------------\nREQUIREMENTS\n-------------\n\nA few commands included in STUBL require `clush \u003chttp://cea-hpc.github.io/clustershell/\u003e`_. \nFor rhel based systems clush is in `EPEL \u003chttps://fedoraproject.org/wiki/EPEL\u003e`_. Debian \nbased systems can run *apt-get install clush*. \n\n-------------\nINSTALL\n-------------\n\n- To install STUBL download the `latest release \u003chttps://github.com/ubccr/stubl/releases\u003e`_::\n\n  $ tar xvf stubl-0.x.x.tar.gz\n  $ cd stubl-0.x.x\n\n- Copy the sample config file and edit to taste::\n\n  $ cp conf/stubl.sample conf/stubl\n  $ vim conf/stubl\n\n- Create empty NodeInfo.log file::\n\n  $ cp log/NodeInfo.log.sample log/NodeInfo.log\n\n- (Optional) Build the slurmbf source::\n\n  $ cd src/slurmbf\n  $ make\n\n- (Optional) Build the slogs_helpers source::\n  $ cd bin/slogs_helpers\n  $ g++ -c *.c *.cpp\n  $ g++ -o tins tins.o\n  $ g++ -o slogplus slogplus.o\n\n- (Optional) Populate slurmbf NodeInfo.log  with clusters node information\n  (RAM, disk size, scratch space, etc.). This will create a file log/NodeInfo.log\n  and can be done by running the following command (can take a while)::\n\n   $ ./bin/GetNodeInfo.sh\n\n- Ensure stubl is in your path::\n\n  $ export STUBL_HOME=/path/to/install/dir/stub-0.x.x\n  $ export PATH=$STUBL_HOME/bin:$PATH\n\n----------------------------------\nSummary of STUBL SLURM Commands\n----------------------------------\n\n- *fisbatch*\n\n  Friendly Interactive SBATCH. A customized version of sbatch that provides a\n  user-friendly interface to an interactive job with X11 forwarding enabled. It\n  is analogous to the PBS \"qsub -I -X\" command. This code was adopted from\n  `srun.x11 \u003chttps://github.com/jbornschein/srun.x11\u003e`_. (requires clush)\n\n- *pbs2sbatch*\n\n  Converts PBS directives to equivalent SLURM SBATCH directives. Accommodates\n  old UB CCR-specific PBS tags like IB1, IB2, etc.\n\n- *pbs2slurm*\n\n  A script that attempts to convert PBS scripts into corresponding SBATCH\n  scripts.  It will convert PBS directives as well as PBS environment variables\n  and will insert bash code to create a SLURM_NODEFILE that is consistent with\n  the PBS_NODEFILE.\n\n- *sausage*\n\n  Retrieves accounting/billing information for a user or account over some period\n  of time.\n\n- *scounts*\n\n  Computes the number of jobs completed by a user, group, or account.\n\n- *sgetscr*\n\n  Retrieves the SLURM/SBATCH script and environment files for a job that is\n  queued or running.\n\n- *sjeff*\n\n  Determines the efficiency of one or more running jobs. Inefficient jobs are\n  high- lighted in red text (requires clush).\n\n- *slimits*\n\n  Retrieves SLURM account limits (e.g. max number of jobs) for the specified user.\n\n- *slist*\n\n  Retrieves SLURM accounting and node information for a running or completed\n  job (requires clush).\n\n- *slogs*\n\n  Retrieves resource usage and accounting information for a user or list of\n  users.  For each job that was run after the given start date, the following\n  information is gathered from the SLURM accounting logs:\n\n  - Number of CPUS\n  - Start Time\n  - Elapsed Time\n  - Amount of RAM Requested\n  - Average RAM Used\n  - Max RAM Used\n\n- *slurmbf*\n\n  Analogous to the PBS \\\"showbf -S\\\" command.\n\n\n- *snacct*\n\n  Retrieves SLURM accounting information for  a given node and for a given\n  period of time.\n\n- *snodes*\n\n  A customized version of sinfo. Displays node information in an\n  easy-to-interpet format. Filters can be applied to view (1) specific nodes,\n  (2) nodes in a specific partition, or (3) nodes in a specifc state.\n\n- *spinfo*\n\n  Show partition information for a cluster(s).\n\n- *sqelp*\n\n  A customized version of squeue that only prints a double-quote if the\n  information in a column is the same from row to row. Some users find this\n  type of formatting easier to visually digest.\n\n- *sqstat*\n\n  A customized version of squeue that produces output analogous to the PBS\n  qstat and xqstat commands (requires clush).\n\n- *sranks*\n\n  A command that lists the overall priorities and associated priority\n  components of queued jobs in ascending order. Top-ranked jobs will be given\n  priority by the scheduler but lower ranked jobs may get slotted in first if\n  they fit into the scheduler's backfill window.\n\n- *stimes*\n\n  Retrieves estimated starting times for queued jobs. All user-provided\n  arguments are passed along to the squeue command.\n\n- *suacct*\n\n  Retrieves SLURM accounting information for a given user's jobs for a given\n  period of time.\n\n- *sueff*\n\n  Determines the overall efficiency of the running jobs of one or more users.\n  Users that are inefficient are highlighted in red text (requires clush).\n\n- *yasqr*\n\n  Yet Another Squeue Replacement. Fixes squeue bugs in earlier versions of\n  SLURM.\n\n----------\nLicense\n----------\n\nSTUBL is released under the GNU General Public License (\"GPL\") Version 3.0.\nSee the LICENSE file.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fubccr%2Fstubl","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fubccr%2Fstubl","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fubccr%2Fstubl/lists"}