Download

If you are reading this documentation, the easiest way to download AthenaK is to clone it directly from the repository page.

Else, you can download from the command line using any git client. Let the target directory for the code be denoted by ${athena}. Then clone with:

$ git clone --recursive https://github.com/IAS-Astrophysics/athenak.git ${athena}

If you are a developer, you may wish to clone using two-factor authentication on GitHub using

$ git clone --recursive \
  https://USERNAME:[email protected]/IAS-Astrophysics/athenak.git ${athena}

where TOKEN is the GitHub personal access token for your USERNAME. Else you will have to enter your credentials every time you try to make a commit.

The --recursive option clones the Kokkos repository along with AthenaK. If you clone the code without Kokkos, you must install it manually in the top-level directory containing the code:

$ git clone https://github.com/IAS-Astrophysics/athenak.git $athena
$ cd ${athena}
$ git submodule init
$ git submodule update