Skip to content
Switch branches/tags

Latest commit


Git stats


Failed to load latest commit information.
Latest commit message
Commit time


This document is to be used to collect a wish list of features before development starts


This code has two major dependencies:

  1. Kokkos
  2. Cabana

Instructions on how to obtain and install both can be found here

Once these are installed, you can configurable and build this project using cmake. To do so, the user should manually tell CMake where to find Cabana, and Cabana should bring Kokkos in for us. If that does not happen, the user should specify the path to Kokkos on the CMAKE_PREFIX_PATH.

An example build line will look something like this:

cmake -DCMAKE_PREFIX_PATH="$HOME/tmp/Cabana/build/install" ..

The default filed solver is "EM"; to use the "ES" solver, add -DSOLVER_TYPE="ES".

For GPU builds, you additionally need to point the CXX compiler to the Kokkos Cuda wrapper, you can do this by doing something like:

cmake -DCMAKE_PREFIX_PATH="$HOME/tmp/Cabana/build/install" -DCMAKE_CXX_COMPILER=$KOKKOS_SRC_DIR/bin/nvcc_wrapper -DENABLE_GPU=ON ..

Remember: Kokkos and Cabana need to be build with GPU support


Users can compile in custom input decks by specifying INPUT_DECK at build time, e.g:

CXX=g++-9 cmake -DCMAKE_PREFIX_PATH="$HOME/tmp/Cabana/build/install" -DINPUT_DECK=./decks/2stream-short.cxx ..

Some example decks live in ./decks. Custom decks must follow the layout put forth in ./src/input/decks.h

Feature Wishlist

  1. Configurable to run in different precisions (real_t to configure float/double)
  2. The particle data store layout should be Configurable (AoS/SoA/AoSoA)
  3. The particle shape function used should be configurable


© (or copyright) 2019. Triad National Security, LLC. All rights reserved.

This program was produced under U.S. Government contract 89233218CNA000001 for Los Alamos National Laboratory (LANL), which is operated by Triad National Security, LLC for the U.S. Department of Energy/National Nuclear Security Administration. All rights in the program are reserved by Triad National Security, LLC, and the U.S. Department of Energy/National Nuclear Security Administration. The Government is granted for itself and others acting on its behalf a nonexclusive, paid-up, irrevocable worldwide license in this material to reproduce, prepare derivative works, distribute copies to the public, perform publicly and display publicly, and to permit others to do so.

This is open source software; you can redistribute it and/or modify it under the terms of the BSD-3 License. If software is modified to produce derivative works, such modified software should be clearly marked, so as not to confuse it with the version available from LANL.


Structured PIC Proxy App Based on Cabana







No releases published


No packages published