Commit de6b418a authored by Valentina Fioretti's avatar Valentina Fioretti
Browse files

Edit README.md

parent 6fd36f21
Loading
Loading
Loading
Loading
+41 −40
Original line number Diff line number Diff line
<img src="images/logo_bogemms_2.png"  width="400" height="120" >

## BoGEMMS-HPC

<details><summary>Building</summary>

Clone or unpack the source code in a location of your choice.

`> <pathto>/BoGEMMS-HPC`

Create a directory in which to configure and run the build and store the build products (not inside the source dir) 

`> makedir <pathto>/BoGEMMS-HPC-build`

To configure, change into the build directory and run CMake

`> cd <pathto>/BoGEMMS-HPC-build`

`> cmake <pathto>/BoGEMMS-HPC`

`> make`

### Building options

- Activating SQLite: `-DSQLBUILD=ON` (default=OFF)
- Activating MongoDB: `-DMONGODBBUILD=ON` (default=OFF)
- Setting the Geant4 version: `-DGEANT4_VERSION=-DGEANT4_11_1` (default GEANT4_11_1)
- Activating the ROOT dependance: `-DNOROOTBUILD=OFF` (default=ON)

`> cmake -DSQLBUILD=ON -DMONGODBBUILD=ON -DGEANT4_VERSION=-DGEANT4_11_1 -DNOROOTBUILD=OFF <pathto>/BoGEMMS-HPC`


</details>

<details><summary>Usage</summary>

- Single node (no mpi): `bogemms -c <conf file> -m <mac file> [OPTIONAL: -s seed]`
- multinode (with mpi): `mpiexec -n <task number> bogemms -c <conf file> -m <mac file> [OPTIONAL: -s seed]`

For more details, check the [getting started guide](./doc/getting_started.md).

</details>

<details><summary>User guide</summary>

[Getting started](./doc/getting_started.md)
@@ -44,45 +84,6 @@ In this case the only dependence is the installation of singularity >=v3.6

</details>

<details><summary>Building</summary>

Clone or unpack the source code in a location of your choice.

`> <pathto>/BoGEMMS-HPC`

Create a directory in which to configure and run the build and store the build products (not inside the source dir) 

`> makedir <pathto>/BoGEMMS-HPC-build`

To configure, change into the build directory and run CMake

`> cd <pathto>/BoGEMMS-HPC-build`

`> cmake <pathto>/BoGEMMS-HPC`

`> make`

### Building options

- Activating SQLite: `-DSQLBUILD=ON` (default=OFF)
- Activating MongoDB: `-DMONGODBBUILD=ON` (default=OFF)
- Setting the Geant4 version: `-DGEANT4_VERSION=-DGEANT4_11_1` (default GEANT4_11_1)
- Activating the ROOT dependance: `-DNOROOTBUILD=OFF` (default=ON)

`> cmake -DSQLBUILD=ON -DMONGODBBUILD=ON -DGEANT4_VERSION=-DGEANT4_11_1 -DNOROOTBUILD=OFF <pathto>/BoGEMMS-HPC`


</details>

<details><summary>Usage</summary>

- Single node (no mpi): `bogemms -c <conf file> -m <mac file> [OPTIONAL: -s seed]`
- multinode (with mpi): `mpiexec -n <task number> bogemms -c <conf file> -m <mac file> [OPTIONAL: -s seed]`

For more details, check the [getting started guide](./doc/getting_started.md).

</details>

<details><summary>Authors</summary>

Coordinator: V. Fioretti (INAF OAS Bologna, valentina.fioretti at inaf.it)
@@ -97,7 +98,7 @@ See doc/LICENSE

</details>

<details><summary>Acknowledgment</summary>
<details><summary>Acknowledgments</summary>

BoGEMMS-HPC is supported by Centro Nazionale di Ricerca in High-Performance Computing, Big Data and Quantum Computing (CN_00000013 - CUP C53C22000350006).