Get Started
###########

.. toctree::
   :maxdepth: 1
   :hidden:

   get-started/quick-start
   get-started/requirements
   get-started/integrating-kokkos-into-your-cmake-project
   get-started/building-from-source
   get-started/configuration-guide
   get-started/package-managers


Want to try Kokkos right away?  Check it out on `Compiler Explorer
<https://godbolt.org/z/svrE563Kn>`_.

:doc:`Quick Start <get-started/quick-start>`
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
This guide provides the minimal first-steps instructions to get started with a
CMake project and start writing Kokkos code.

:doc:`Integrating Kokkos into Your Project <get-started/integrating-kokkos-into-your-cmake-project>`
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
This guide discusses in details how to setup your project to use Kokkos.

:doc:`Requirements <get-started/requirements>`
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
This page details the supported versions of various components required to
build and use Kokkos, including build systems, vendor toolchains, compilers,
C++ standards, and target architectures (both CPU and GPU).  A comprehensive
table lists compatible combinations of these components.

:doc:`Building from Source <get-started/building-from-source>`
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
This guide provides instructions for downloading the Kokkos source code,
configuring to generate the build system, compiling the library, and installing
it on your system.

:doc:`Configuration Guide <get-started/configuration-guide>`
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
This page provides a comprehensive reference for all Kokkos configuration
options, including backend selection for targeting specific hardware setups,
general and backend-specific CMake options, control over third-party library
usage, and a complete list of supported CPU and GPU architectures.

:doc:`Package Managers <get-started/package-managers>`
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
This page lists package managers that offer pre-built Kokkos packages,
providing a convenient alternative to building from source.