X-Point Gyrokinetic Code (XGC)

Contents

  • General Information
  • How to Become an XGC User
  • Introduction to XGC’s Git Workflow
  • Quickstart
  • Building XGC
    • Build Instructions
    • 3rd Party Software Installations
    • Maintaining shared installations
    • Installation instructions
    • Adding a new source file
    • Adding support for another HPC facility
    • Adding a new configuration option
    • Updating Test Data
  • Running XGC
  • Kernels and Tests
  • Versioning and Updates
  • Continuous Integration
  • XGC API Documentation
  • XGC Preprocessor Macros
  • XGC Inputs
  • Generating Meshes for XGC Simulations
  • File Format of XGC Mesh Files
  • XGC algorithms
  • XGC Outputs
X-Point Gyrokinetic Code (XGC)
  • Building XGC
  • View page source

Building XGC

Please open a Github issue if you encounter any bugs or other problems. Thanks! Before getting started, please make sure you have CMake v3.16 or newer installed.

Contents

  • Build Instructions
    • Environment at HPC facilities
      • Aurora
      • Frontier
      • Greene
      • Perlmutter (GPU)
      • Perlmutter (CPU)
      • Polaris
      • Stellar
    • Build instructions for XGC-S
      • Stellar
      • Perlmutter
  • 3rd Party Software Installations
  • Maintaining shared installations
  • Installation instructions
    • PETSc
    • ADIOS2
    • FFTW
    • Kokkos
    • Cabana
    • GTest
    • Ginkgo
  • 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
Previous Next

© Copyright 2021, Seung-Hoe Ku, Robert Hager and the XGC-Team. Last updated on May 19, 2025.

Built with Sphinx using a theme provided by Read the Docs.