Skip to content

Commit c2117cb

Browse files
authored
Copyedits for grammar and standardization
1 parent cbf6fca commit c2117cb

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

scripts/WORKFLOW-EXAMPLES.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
# Job examples
1+
# Job Examples
22

33
1. [PDF to Wordcloud](#pdf-to-wordcloud-image)
4-
2. [Executing a singularity container](#executing-a-singularity-container)
5-
3. [Submitting a MPI job](#executing-an-mpi-job)
4+
2. [Executing a Singularity Container](#executing-a-singularity-container)
5+
3. [Submitting a MPI Job](#executing-an-mpi-job)
66

77
## PDF to Wordcloud Image
88

@@ -19,11 +19,11 @@ Steps:
1919

2020
![image](../web/images/wordcloud-workflow.svg)
2121

22-
1. extract text from PDF file
22+
1. Extract text from PDF file.
2323

2424
`pdftotext INPUT.pdf OUTPUT.txt`
2525

26-
2. create image from text
26+
2. Create image from text.
2727

2828
`wordcloud_cli.py --text OUTPUT.txt --imagefile IMAGE.png`
2929

@@ -87,7 +87,7 @@ for j in [pdf2textJob, text2wordcloudJob]:
8787
```
8888

8989

90-
The tools used in the example above can be easily installed in a docker container:
90+
The tools used in the example above can be easily installed in a Docker container:
9191

9292
```
9393
FROM ubuntu:latest
@@ -98,9 +98,9 @@ RUN apt-get install -y \
9898
RUN pip install wordcloud
9999
```
100100

101-
## Executing a singularity container
101+
## Executing a Singularity Container
102102

103-
We will run the PDF2Wordcloud example in a container. We will use the docker container described above and execute it with singularity. In this case the spec defines the execution of a container with singularity. The actual command line tool is passed as an optional argument after all required singularity options.
103+
We will run the PDF2Wordcloud example in a container. We will use the Docker container described above and execute it with singularity. In this case the spec defines the execution of a container with singularity. The actual command line tool is passed as an optional argument after all required singularity options.
104104

105105
```
106106
...
@@ -161,11 +161,11 @@ for j in [make_job(pdf2textSingularitySpec, None), make_job(text2wordcloudSingul
161161
j.wait()
162162
```
163163

164-
## Executing an MPI job
164+
## Executing an MPI Job
165165

166166
In this example we demonstrate how to wrap and execute an mpi hello world job with PSI/J. The base mpi command is `mpiexec -n 36 -ppn 36 echo Hello world`. This example is introducing the concept of a [job launcher](https://exaworks.org/psij-python/docs/programming.html#launchers), in this case **mpi**, e.g. `job.spec.launcher = "mpirun"`. The complete example script can be found [here](./).
167167

168-
1. Load psij module and instantiate job executer, e.g. local or slurm
168+
1. Load psij module and instantiate job executer, e.g. local or Slurm
169169

170170
```
171171
import psij

0 commit comments

Comments
 (0)