1Slurm Workload Manager
2--------------------------------------------------------
3
4This is the Slurm Workload Manager. Slurm
5is an open-source cluster resource management and job scheduling system
6that strives to be simple, scalable, portable, fault-tolerant, and
7interconnect agnostic. Slurm currently has been tested only under Linux.
8
9As a cluster resource manager, Slurm provides three key functions. First,
10it allocates exclusive and/or non-exclusive access to resources
11(compute nodes) to users for some duration of time so they can perform
12work. Second, it provides a framework for starting, executing, and
13monitoring work (normally a parallel job) on the set of allocated
14nodes. Finally, it arbitrates conflicting requests for resources by
15managing a queue of pending work.
16
17NOTES FOR GITHUB DEVELOPERS
18---------------------------
19
20The official issue tracker for Slurm is at
21  https://bugs.schedmd.com/
22
23We welcome code contributions and patches, but **we do not accept Pull Requests
24through Github at this time.** Please submit patches as attachments to new
25issues under the "C - Contributions" severity level.
26
27SOURCE DISTRIBUTION HIERARCHY
28-----------------------------
29
30The top-level distribution directory contains this README as well as
31other high-level documentation files, and the scripts used to configure
32and build Slurm (see INSTALL). Subdirectories contain the source-code
33for Slurm as well as a DejaGNU test suite and further documentation. A
34quick description of the subdirectories of the Slurm distribution follows:
35
36  src/        [ Slurm source ]
37     Slurm source code is further organized into self explanatory
38     subdirectories such as src/api, src/slurmctld, etc.
39
40  doc/        [ Slurm documentation ]
41     The documentation directory contains some latex, html, and ascii
42     text papers, READMEs, and guides. Manual pages for the Slurm
43     commands and configuration files are also under the doc/ directory.
44
45  etc/        [ Slurm configuration ]
46     The etc/ directory contains a sample config file, as well as
47     some scripts useful for running Slurm.
48
49  slurm/      [ Slurm include files ]
50     This directory contains installed include files, such as slurm.h
51     and slurm_errno.h, needed for compiling against the Slurm API.
52
53  testsuite/  [ Slurm test suite ]
54     The testsuite directory contains the framework for a set of
55     DejaGNU and "make check" type tests for Slurm components.
56     There is also an extensive collection of Expect scripts.
57
58  auxdir/     [ autotools directory ]
59     Directory for autotools scripts and files used to configure and
60     build Slurm
61
62  contribs/   [ helpful tools outside of Slurm proper ]
63     Directory for anything that is outside of slurm proper such as a
64     different api or such.  To have this build you need to do a
65     make contrib/install-contrib.
66
67COMPILING AND INSTALLING THE DISTRIBUTION
68-----------------------------------------
69
70Please see the instructions at
71  https://slurm.schedmd.com/quickstart_admin.html
72Extensive documentation is available from our home page at
73  https://slurm.schedmd.com/slurm.html
74
75LEGAL
76-----
77
78Slurm is provided "as is" and with no warranty. This software is
79distributed under the GNU General Public License, please see the files
80COPYING, DISCLAIMER, and LICENSE.OpenSSL for details.
81