Commit 6fd36f21 authored by Valentina Fioretti's avatar Valentina Fioretti
Browse files

Edit README.md

parent f54fa866

README.md

+35 −15
Original line number Diff line number Diff line 
<img src="images/logo_bogemms_2.png"  width="400" height="120" >



## Supported platforms

## BoGEMMS-HPC

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



[Getting started](./doc/getting_started.md)



[Geometry](./doc/geometry.md)



[Physics](./doc/physics.md)



[Examples](./doc/examples.md)



</details>





<details><summary>Supported platforms</summary>



BoGEMMS-HPC has been tested on CentOS >=7 Linux with GCC >=8 64 bits and macOS Ventura with Apple-LLVM (Xcode) 14 (Intel and ARM).



## Dependencies

</details>



<details><summary>Dependencies</summary>



- the Geant4 Toolkit v11.1, which requires a C++ Compiler and Standard Library supporting the C++17 Standard, (Linux: GNU Compiler Collection 8 or higher, macOS: Apple Clang (Xcode) 12 or higher), CMake 3.16 or higher (see the [Geant4 installation guide](https://geant4-userdoc.web.cern.ch/UsersGuides/InstallationGuide/BackupVersions/V11.1b/html/gettingstarted.html#os-software-prerequisites) for further information).

- cfitsio (tested with v3.47)
@@ -14,7 +30,9 @@ BoGEMMS-HPC has been tested on CentOS >=7 Linux with GCC >=8 64 bits and macOS V 
- MongoDB c++ driver (tested with v4.0.0)

- (optional) ROOT >= v6



## Containerization

</details>



<details><summary>Containerization</summary>



We provide two singularity containers:

- a CentOS-stream container with all dependencies except MongoDB (lighter) - [here](https://drive.google.com/file/d/1t6vuAnaDwjs_rHn6Y3kamSMkKQSd8W62/view?usp=sharing)
@@ -24,8 +42,9 @@ In this case the only dependence is the installation of singularity >=v3.6 


`> singularity shell <container name>`



</details>



## Building

<details><summary>Building</summary>



Clone or unpack the source code in a location of your choice.
@@ -52,35 +71,36 @@ To configure, change into the build directory and run CMake 


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



## Usage



</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).



## Support



Work in progress

</details>







## Authors

<details><summary>Authors</summary>



Coordinator: V. Fioretti (INAF OAS Bologna, valentina.fioretti at inaf.it)



Contributors: V. Fioretti (INAF OAS Bologna), A. Ciabattoni (INAF OAS Bologna), A. Bulgarelli (INAF OAS Bologna), N. Parmiggiani (INAF OAS Bologna)



</details>



## License

<details><summary>License</summary>



See doc/LICENSE



</details>



## Acknowledgment

<details><summary>Acknowledgment</summary>



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



## BoGEMMS-HPC user guide

</details>



[Getting started](./doc/getting_started.md)