Commit 737164ed authored by Adel Kara Slimane's avatar Adel Kara Slimane
Browse files

Update INSTALL.md

parent e7810f94
Pipeline #34421 failed with stages
in 23 minutes and 42 seconds
......@@ -73,10 +73,10 @@ The same tools and libraries need to be installed, but they have different names
### Running scripts
You should be able to use kwant and tkwant now in the command line in that virtual environment. For example one can run the example `quantum_dot.py` from the `examples` folder:
You should be able to use kwant and tkwant now in the command line in that virtual environment. For example one can run the example `quantum_dot.py` from the `doc/examples` folder:
```shell
python3 examples/quantum_dot.py
python3 doc/examples/quantum_dot.py
```
#### Parallel calculations
......@@ -84,17 +84,17 @@ python3 examples/quantum_dot.py
To make the calculation faster, it is possible to run scripts on several parallel cores. The script in the `examples` folder can for example be run in parallel on 10 cores:
```shell
mpirun -n 10 -bind-to none python3 examples/quantum_dot.py
mpirun -n 10 -bind-to none python3 doc/examples/quantum_dot.py
```
The `-bind-to none` option is there to not force the OS to use specific threads to run the 10 copies. If not used, the code will run on the first 10 threads of the machine. And if another script is ran in parallel using the same command, the same cores will be used for the second script, which will make the simulation slower, since the same cores are used for both simulations. There's also the possibility of choosing the threads on which to run the script
```shell
mpirun -n 5 --cpu-set 0-4 --bind-to core python3 examples/quantum_dot.py
mpirun -n 5 --cpu-set 0-4 --bind-to core python3 doc/examples/quantum_dot.py
```
Where threads 0,1,2,3,4 will be used for the calculations, the same command can be written:
```shell
mpirun -n 5 --cpu-set 0,1,2,3,4 --bind-to core python3 examples/quantum_dot.py
mpirun -n 5 --cpu-set 0,1,2,3,4 --bind-to core python3 doc/examples/quantum_dot.py
```
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment