Repository files navigation

This is the Slurm Workload Manager. Slurm is an open-source clusterresource management and job scheduling system that strives to be simple,scalable, portable, fault-tolerant, and interconnect agnostic. Slurmcurrently has been tested only under Linux.

As a cluster resource manager, Slurm provides three key functions.First, it allocates exclusive and/or non-exclusive access to resources(compute nodes) to users for some duration of time so they can performwork. Second, it provides a framework for starting, executing, andmonitoring work (normally a parallel job) on the set of allocated nodes.Finally, it arbitrates conflicting requests for resources by managing aqueue of pending work.

The official issue tracker for Slurm is at

:https://support.schedmd.com/

We welcome code contributions and patches, butwe do not accept PullRequests through Github at this time. Please submit patches asattachments to new issues under the "C - Contributions" severitylevel.

The top-level distribution directory contains this README as well asother high-level documentation files, and the scripts used to configureand build Slurm (see INSTALL). Subdirectories contain the source-codefor Slurm as well as a test suite and further documentation. A quickdescription of the subdirectories of the Slurm distribution follows:

src/ [ Slurm source ]

: Slurm source code is further organized into self explanatorysubdirectories such as src/api, src/slurmctld, etc.

doc/ [ Slurm documentation ]

: The documentation directory contains some latex, html, and asciitext papers, READMEs, and guides. Manual pages for the Slurmcommands and configuration files are also under the doc/directory.

etc/ [ Slurm configuration ]

: The etc/ directory contains a sample config file, as well as somescripts useful for running Slurm.

slurm/ [ Slurm include files ]

: This directory contains installed include files, such as slurm.hand slurm_errno.h, needed for compiling against the Slurm API.

testsuite/ [ Slurm test suite ]

: The testsuite directory contains an extensive collection of testswritten for Check, Expect and Pytest.

auxdir/ [ autotools directory ]

: Directory for autotools scripts and files used to configure andbuild Slurm

contribs/ [ helpful tools outside of Slurm proper ]

: Directory for anything that is outside of slurm proper such as adifferent api or such. To have this build you need to do a makecontrib/install-contrib.

Please see the instructions at

:https://slurm.schedmd.com/quickstart_admin.html

Extensive documentation is available from our home page at

:https://slurm.schedmd.com/slurm.html

Slurm is provided "as is" and with no warranty. This software isdistributed under the GNU General Public License, please see the filesCOPYING, DISCLAIMER, and LICENSE.OpenSSL for details.