|
|
# Executables
|
|
|
Once the installation of HERMESv3_BU is finished the following executables will be available:
|
|
|
|
|
|
1. ```hermesv3_bu```: Main HERMESv3_BU model.
|
|
|
2. ```hermesv3_bu_download_benchmark```: Used to download HERMESv3_BU benchmark test case.
|
|
|
|
|
|
## HERMESv3_BU
|
|
|
hermesv3_bu is the executable of the HERMESv3_BU model.
|
|
|
|
|
|
In order to execute it, the path to the configuration file needs to be provided as follows:
|
|
|
|
|
|
```bash
|
|
|
hermesv3_bu --my-config '/home/user/hermesv3_bu/conf/hermes.conf'
|
|
|
|
|
|
# or
|
|
|
|
|
|
hermesv3_bu -c '/home/user/hermesv3_bu/conf/hermes.conf'
|
|
|
```
|
|
|
|
|
|
In order to execute HERMESv3_BU in parallell, the number of processors should also be defined. In the following example, HERMESv3_BU is executed using 24 cpus:
|
|
|
|
|
|
```bash
|
|
|
mpirun -np 24 hermesv3_bu --my-config '/home/user/hermesv3_bu/conf/hermes.conf'
|
|
|
|
|
|
# or
|
|
|
|
|
|
mpirun -np 24 hermesv3_bu -c '/home/user/hermesv3_bu/conf/hermes.conf'
|
|
|
```
|
|
|
|
|
|
Configuration options can be passed to HERMESv3_BU via the configuration file (hermes.conf), arguments or a combination of both.
|
|
|
The arguments passed by command line take priority from the one that appears in the configuration file. To adquire more information about the arguments you can call the hermes help:
|
|
|
|
|
|
```bash
|
|
|
hermesv3_bu --help
|
|
|
|
|
|
# or
|
|
|
|
|
|
hermesv3_bu -h
|
|
|
```
|
|
|
|
|
|
## hermesv3_bu_download_benchmark
|
|
|
This executable allows the user to download the configuration file and benchmark output comparison data to [test the build of HERMESv3_BU](examples_benchmark).
|
|
|
This step is not required to run HERMESv3_BU but it is recommended for new users.
|
|
|
The command to execute the file is as follows:
|
|
|
```bash
|
|
|
hermesv3_bu_download_benchmark '<PATH_INSTALLATION>/hermesv3_bu_benchmark/'
|
|
|
```
|
|
|
|
|
|
[Go to User guide page](user_guide) |
|
|
\ No newline at end of file |