moebiusband/MD-Bench
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update README.md to fix lists

Browse Source 
Signed-off-by: Rafael Ravedutti <rafaelravedutti@gmail.com>
This commit is contained in:
Rafael Ravedutti 2021-06-11 16:42:23 +02:00
parent 977bc68699
commit 933f7c7bba
1 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
util/README.md
View File

@ -4,11 +4,11 @@
**run_stub.sh:** Bash script to run the MD-Bench stubbed force calculation for different configurations and evaluate the performance. **run_stub.sh:** Bash script to run the MD-Bench stubbed force calculation for different configurations and evaluate the performance.
The configuration parameters are: The configuration parameters are:
*-a <numbers>:* specify the number of atoms per unit cell (the number of neighbors per atom is this value minus 1), the default is 8. - **-a <numbers>:** specify the number of atoms per unit cell (the number of neighbors per atom is this value minus 1), the default is 8.
*-n <numbers>:* timesteps to run the simulation, the default is 200. - **-n <numbers>:** timesteps to run the simulation, the default is 200.
*-nx <numbers>:* number of unit cells in the x dimension, the default is 4. - **-nx <numbers>:** number of unit cells in the x dimension, the default is 4.
*-ny <numbers>:* number of unit cells in the y dimension, the default is 4. - **-ny <numbers>:** number of unit cells in the y dimension, the default is 4.
*-nz <numbers>:* number of unit cells in the z dimension, the default is 2. - **-nz <numbers>:** number of unit cells in the z dimension, the default is 2.
Notice that these parameters can also be specified as lists, which executes the stubbed force calculation several times varying the specific parameter to each element of the list. Notice that these parameters can also be specified as lists, which executes the stubbed force calculation several times varying the specific parameter to each element of the list.
All combinations of parameters are executed! All combinations of parameters are executed!
@ -28,8 +28,8 @@ Will execute the stubbed force calculation for the following 4 configurations:
``` ```
The following parameters are also available: The following parameters are also available:
*-f <frequency>:* CPU frequency in GHz (assure your CPU frequency is fixed by disabling Turbo mode), more performance metrics such as cycles per iteration are displayed if this option is defined. - **-f <frequency>:** CPU frequency in GHz (assure your CPU frequency is fixed by disabling Turbo mode), more performance metrics such as cycles per iteration are displayed if this option is defined.
*-o <file>:* output file (.txt) for the results, the default is *run_results.txt*. - **-o <file>:** output file (.txt) for the results, the default is *run_results.txt*.
*-r <runs>:* number of runs for each configuration (only the values for the best run are displayed), the default is 3. - **-r <runs>:** number of runs for each configuration (only the values for the best run are displayed), the default is 3.
**plot_run_stub_data.py:** Python script to plot the data generated by the *run_stub.sh* script. Just provide the name of the .txt file as a parameter and this script generates a corresponding PDF with the same file name. **plot_run_stub_data.py:** Python script to plot the data generated by the *run_stub.sh* script. Just provide the name of the .txt file as a parameter and this script generates a corresponding PDF with the same file name.