Installation

Requirements

• Apptainer

1. Install <em>apptainer</em>

1. Install apptainer following the installation instructions.

2. Get the repository and build the documentation

1. Clone the repository or download the Source code for the latest release
2. Download the jive.sif for the latest release and place it in the folder with the repository
3. Define an appropriate alias for running inside the apptainer alias jive="apptainer exec $(pwd)/jive.sif"
4. Build the documentation via jive make docs (this will execute the test cases as well, but not the second example from Usage)

3. Extend the code or use it for new cases

1. You can build the code via jive make and then execute any test via jive bin/dynLattice path/to/inputs.pro
2. Once you are done with your setup and sure everything works, build the optimized version via jive make opt and then run bin/dynLattice-opt path/to/inputs.pro
3. If you want to debug your own additions using the GNU Project debugger build jive make debug and then run jive gdb bin/dynLattice-dbg
   • proceed with (gdb) run path/to/inputs.pro
   • use (gdb) call dprint(&variable) to get the variable printed if it is a Vector or a Matrix

(Optional, instead of 2.2 above) build the *.sif* file yourself

A .def file is provided to build the container yourself.

1. Put all the required archives into a directory called zips.
   • JEM/JIVE 3.0
   • OpenMPI 4.1.1
   • GMSH 4.9.5
   • HDF5 1.12.2
2. Run the command sudo apptainer build jive.sif jive.def.