Skip to content

Commit 5d418e5

Browse files
Minor changes to documentation following recent tests, including NumPy v2, and OpenMPI update. This closes #22
1 parent 1fcc4b5 commit 5d418e5

File tree

5 files changed

+13
-10
lines changed

5 files changed

+13
-10
lines changed

GUIDE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -392,7 +392,7 @@ for all this output to be collated (in an undefined order) and written to a sing
392392
was carried out using Open MPI, which allows the program to be run with a command line which includes
393393
an option for each process to write to separate files, similar to the following:
394394
```
395-
mpirun -np 4 -output-filename out ./mc_nvt_lj_re < mc.inp
395+
mpirun -np 4 --output dir=out ./mc_nvt_lj_re < mc.inp
396396
```
397397
whereby the output files are placed in subdirectories,
398398
identified by process rank,

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ A few examples consist of individual routines or modules,
5959
rather than working programs,
6060
so there is no need to build them.
6161

62-
The build process for the Fortran examples has been tested using SCons v4.8.0
62+
The build process for the Fortran examples has been tested using SCons v4.8.1
6363
(and some earlier versions back to v2.5.1 with minor changes to the `SConstruct` file).
6464

6565
If you don't like using SCons, or can't get it to work,
@@ -78,7 +78,7 @@ it is advisable to __compile each example in its own build directory__
7878
(which is what the `SConstruct` file is configured to do)
7979
or to delete all intermediate files before each individual compilation.
8080

81-
We have used gfortran v13.2.0 (and earlier versions back to v6.3) for testing,
81+
We have used gfortran v14.2.0 (and earlier versions back to v6.3) for testing,
8282
but have attempted to stick to code which conforms to the Fortran 2018 standard.
8383
Note that, by default, we do not select any optimization options in compilation.
8484
If you are using a different compiler,
@@ -89,8 +89,8 @@ Unfortunately, due to the enormous variety of computing platforms and compilers,
8989
__we cannot offer more specific advice on the build process.__
9090

9191
The Python versions do not require building, they are simply run through the Python interpreter.
92-
They have been tested with Python 3.12.2 and NumPy 1.26.4
93-
(and previously, Python versions back to 3.6.0).
92+
They have been tested with Python 3.13.3 and NumPy 2.2.5
93+
(and previously, Python versions back to 3.6.0, and NumPy v1 up to 1.26.4).
9494

9595
## Random number generators
9696

SConstruct

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@
44

55
import os, sys
66

7-
# This has been tested using SCons v4.6.0, gfortran v13.2.0,
8-
# using MacOS (Ventura 13.6.3, Xcode 15.1) with compilers and libraries installed through MacPorts.
7+
# This has been tested using SCons v4.8.1, gfortran v14.2.0,
8+
# using MacOS (Sequoia 15.5.3, Xcode 16.3) with compilers and libraries installed through MacPorts.
99
# It may not work on your system. It is possible that you can get it to work by
1010
# changing the flags and library/include paths defined in the following few statements.
1111
# The most likely trouble spots are the programs that use the non-standard

python_examples/GUIDE.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,9 @@ especially for combining arrays.
2828
On top of this, NumPy and the [SciPy](https://www.scipy.org/ "SciPy home page") package
2929
provide a huge variety of scientific libraries,
3030
and our Python examples make extensive use of these.
31+
Our codes were originally written using NumPy v1,
32+
but the transition to NumPy v2 has involved very few, minor, changes to them.
33+
3134
Nonetheless,
3235
any code which cannot be handled in vectorized form by NumPy will still run slowly.
3336
Several strategies are available to address these issues
@@ -398,7 +401,7 @@ for all this output to be collated (in an undefined order) and written to a sing
398401
was carried out using Open MPI, which allows the program to be run with a command line which includes
399402
an option for each process to write to separate files, similar to the following:
400403
```
401-
mpiexec -n 4 -output-filename out ./mc_nvt_lj_re.py < mc.inp
404+
mpiexec -n 4 --output dir=out ./mc_nvt_lj_re.py < mc.inp
402405
```
403406
whereby the output files are placed in subdirectories,
404407
identified by process rank,

python_examples/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,6 @@ The [User Guide](./GUIDE.md) contains some comments on the Python language,
3131
some notes to assist in running the programs,
3232
and some typical results.
3333
The Python versions do not require building, they are simply run through the Python interpreter.
34-
They have been tested with Python 3.12.2 and NumPy 1.26.4
35-
(and previously, Python versions back to 3.6.0).
34+
They have been tested with Python 3.13.3 and NumPy 2.2.5
35+
(and previously, Python versions back to 3.6.0, and NumPy v1 up to 1.26.4).
3636

0 commit comments

Comments
 (0)