@@ -4,13 +4,13 @@ The PSI/J API
44The most important classes in this library are ``Job `` and ``JobExecutor ``,
55followed by ``Launcher ``.
66
7- The Job class and its modifiers
7+ The Job Class and Its Modifiers
88~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
99
1010The Job-related classes listed in this section (``Job ``, ``JobSpec ``,
1111``ResourceSpec ``, and ``JobAttributes ``) are independent of
1212executor implementations. The authors strongly recommend that users
13- program against these classes, rather than adding executor-specific
13+ program against these classes rather than adding executor-specific
1414configuration options, to the extent possible.
1515
1616.. autoclass :: psij.Job
@@ -25,15 +25,15 @@ configuration options, to the extent possible.
2525 :members:
2626 :noindex:
2727
28- Job modifiers
28+ Job Modifiers
2929^^^^^^^^^^^^^
3030
3131There can be a lot of configuration information that goes into each
3232resource manager job. Its walltime, partition/queue, the number of nodes
3333it needs, what kind of nodes, what quality of service the job requires, and
3434so on.
3535
36- PSI/J splits those three attributes into three groups: one for generic
36+ PSI/J splits those attributes into three groups: one for generic
3737POSIX information, one for resource information, and one for resource manager
3838scheduling policies.
3939
@@ -59,15 +59,15 @@ Executors are concrete implementations of mechanisms that execute jobs.
5959To get an instance of a specific executor, call
6060:meth: `JobExecutor.get_instance(name) <psij.job_executor.JobExecutor.get_instance> `,
6161with ``name `` being one of the installed executor names. Alternatively, directly
62- instantiate the executor, e.g.
62+ instantiate the executor, e.g.:
6363
6464.. code-block :: python
6565
6666 from psij.executors.flux import FluxJobExecutor
6767
6868 ex = FluxJobExecutor()
6969
70- Rather than
70+ Rather than:
7171
7272.. code-block :: python
7373
@@ -152,15 +152,15 @@ are wrappers around the job executable which can provide additional
152152features, such as setting up an MPI environment, starting a copy of the
153153job executable on each allocated node, etc. To get a launcher instance,
154154call :meth: `Launcher.get_instance(name) <psij.launcher.Launcher.get_instance> `
155- with ``name `` being the name of a launcher. Like job executors, above,
155+ with ``name `` being the name of a launcher. Like job executors,
156156launchers are plugins and can come from various places. To obtain a list
157157of launchers, you can run:
158158
159159.. code-block :: shell
160160
161161 $ python -m psij plugins
162162
163- Launcher base class
163+ Launcher Base Class
164164^^^^^^^^^^^^^^^^^^^
165165
166166Like the executor, the ``Launcher `` base class is abstract, but offers
0 commit comments