Getting Started

The Nyx source code currently lives in a github repository that can be cloned by using git:

> git clone https://github.com/AMReX-Astro/Nyx.git --recursive

Note

We recommend Git version 1.7.x or higher.

Once you have obtained the source code, the following sections describe the source code contents, compiling, running a simple simulation, and visualizing the simulations results.

• Source directory overview
• AMReX basics
• Building Nyx with GNU Make
• Building Nyx with CMake
• Running the code
• Compiling Nyx with SUNDIALS 5

Additional details about compiling Nyx in different environments can be found in the AMReX build documentation . Containerized Ubuntu builds with CMake are run as GitHub Actions whose workflow files are stored in Nyx/.github/workflows .