GitLab

This is the Spinifel user and developer guide

Building Spinifel

For information on building Spinifel, please see:

• Building Spinifel

Running Spinifel

Here is a general overview of how to run Spinifel:

• Running Spinifel

If you want to see how to run on some popular HPC system, take a look at our gentle introduction on Spinifel:

• Quick Start on Summit
• Quick Start on Cori GPU
• Quick Start on Perlmutter
• Quick Start on psana

If your scripts folder contains the run_summit_*.sh and run_cori.sh files, you need to use the quick-start guides below -- otherwise use the ones above:

• Legacy Quick Start on Summit
• Legacy Quick Start on Cori GPU

Step-by-steps how to run Spinifel with Xtc2 (PSANA2 required):

• Running Spinifel with Xtc2
• Note on Xtc1/Hdf5 to Xtc2 data formats conversion

Developer Guide

NOTE: The developer guide refers to the code in the development branch, or newer.

• Profiling Spinifel
• Using External Modules
• Spinifel Settings

CI

• Continuous Integration