Skip to content

Commit 01c1165

Browse files
committed
updated README.md with information about the number of precesses when using mpirun
1 parent 1628411 commit 01c1165

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

README.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ When running this software, there is a chance of generating an inf or NaN value.
4949
```
5050

5151
If the value of `p2` generated by the eSS solver is 0, the model eval produces an inf value. To avoid this, when the
52-
evaluation of the ODE generates a non-finite value, the software will set the value of the variable to 0. If you
52+
evaluation of the ODE generates a non-finite value, the software will set it to 0. If you
5353
want to change this behavior, you can set the value you want the variable to take when an invalid value is
5454
generated by setting the environment variable `CUQDYN_DEF_YDOT` to the desired value.
5555

@@ -110,6 +110,9 @@ After this, the file `output/cuqdyn-results.txt` contains the results of the
110110
algorithm but reading it as a plain text is not very useful.
111111
To fix this, you can run: (Needs python3 and matplotlib installed)
112112

113+
Note: Be carefull when executing with `mpirun`, the number of precesses must be divisor
114+
of m - 1, where m is the number of rows in the input data matrix.
115+
113116
```bash
114117
python3 plot.py output/cuqdyn-results.txt
115118
```
@@ -129,11 +132,11 @@ Also, you can run
129132
./build-{variant}/modules/cli/cli version
130133
```
131134

132-
to get the version of the cuqdyn-c lib and cli you are using.
135+
to get the version of the cuqdyn-c lib, sacess lib and cli you are using.
133136

134137
## Input files
135138

136-
There are three types of input files needed to run the cli:
139+
There are three types of input files that must be provided:
137140

138141
- **eSS Solver config xml:**
139142
This file contains the configuration of the eSS solver used in the sacess library.

0 commit comments

Comments
 (0)