Skip to content

Commit 0e9153d

Browse files
committed
Update documentation in README.md
1 parent c6bad4f commit 0e9153d

File tree

1 file changed

+13
-2
lines changed

1 file changed

+13
-2
lines changed

README.md

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,11 @@ Names: Gaspare Li Causi, Lorenzo Tomada
22

33
email: glicausi@sissa.it, ltomada@sissa.it
44

5+
# TODO:
6+
- documentation in the script folder (explain what we are doing)
7+
- run using ulysses
8+
- find a way to import functions in memory profiling
9+
510
# Introduction
611
This repository contains the final project for the course in Development Tools in Scientific Computing.
712

@@ -43,8 +48,14 @@ Assuming that you are in the root folder of the project, it sufficies to use
4348
```bash
4449
python scripts/mpi_running.py
4550
```
46-
In the `shell` folder, we provide a `submit.sbatch` file to run using `SLURM`, as well as a `submit.sh` to run the same experiment locally.
47-
In particular, these two files perform memory profiling.
51+
The previous command will run the script using as configuration file (containing, e.g., matrix size and number of processes) the file `experiments/config.yaml`.
52+
It is also possible to provide paths to other configuration files by passing the corresponding path through the `--config=path/to/file` command.
53+
54+
Notice that the script is *not* called using `mpirun`, but internally it uses MPI.
55+
This is done by spawning a communicator inside the script.
56+
57+
In addition, in the `shell` folder, we provide a `submit.sbatch` file to run using `SLURM`, as well as a `submit.sh` to run the same experiment locally.
58+
These two files perform memory profiling.
4859

4960
# To install using Ulysses:
5061
```bash

0 commit comments

Comments
 (0)