Building XGC with CMake

A currently experimental CMake build system is included with XGC. Since this build system is still being developed, please understand that it might not always work for you. Before getting started, please make sure you have CMake v3.10 or newer installed.

Contents

• CMake Build Instructions
  • Overview
  • Managing dependencies
    • Local Development
    • Building at HPC facilities
• Adding a new source file
• Adding support for another HPC facility
• Adding a new configuration option
• Updating Test Data
  • Generate new test data
    • Make whatever changes are necessary to the testing data.
    • Create a tarball of the new version of the test data
  • Upload new version to data.kitware.com
    • Register an account on data.kitware.com if you don’t already have one.
    • Navigate to your public folder
    • Upload the newly created tarball to your public directory
  • Update the version of the test data used in XGC
    • Get the checksum of this new version
    • Record the new checksum in XGC
    • Commit, push, and make a PR for this change