{"id":22410971,"url":"https://github.com/e3sm-project/ekat","last_synced_at":"2025-07-31T21:31:07.520Z","repository":{"id":37890205,"uuid":"285631667","full_name":"E3SM-Project/EKAT","owner":"E3SM-Project","description":"Tools and libraries for writing Kokkos-enabled HPC C++ in E3SM ecosystem","archived":false,"fork":false,"pushed_at":"2024-11-27T20:35:35.000Z","size":1654,"stargazers_count":16,"open_issues_count":34,"forks_count":7,"subscribers_count":19,"default_branch":"master","last_synced_at":"2024-11-27T21:21:31.606Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"C++","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/E3SM-Project.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":".github/CONTRIBUTING.md","funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-08-06T17:31:01.000Z","updated_at":"2024-11-25T10:13:14.000Z","dependencies_parsed_at":"2023-12-24T23:32:33.210Z","dependency_job_id":"17b7a6af-441d-4f3e-bab9-6cbca76cbc71","html_url":"https://github.com/E3SM-Project/EKAT","commit_stats":{"total_commits":686,"total_committers":19,"mean_commits":36.10526315789474,"dds":"0.39650145772594747","last_synced_commit":"0c687c39856466bf2fcb04d9fee259fd225ec0a2"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/E3SM-Project%2FEKAT","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/E3SM-Project%2FEKAT/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/E3SM-Project%2FEKAT/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/E3SM-Project%2FEKAT/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/E3SM-Project","download_url":"https://codeload.github.com/E3SM-Project/EKAT/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":228304099,"owners_count":17898920,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-12-05T13:12:33.101Z","updated_at":"2024-12-05T13:12:33.762Z","avatar_url":"https://github.com/E3SM-Project.png","language":"C++","funding_links":[],"categories":[],"sub_categories":[],"readme":"# EKAT Version 1.0: E3SM Kokkos Applications Toolkit\n\nEKAT is a small library, containing tools and libraries for writing Kokkos-enabled HPC C++ in the E3SM ecosystem.\nTools include C++/Fortran code (data structures, functions, macros) as well as CMake scripts.\n\nPlease, read our [guidelines](https://github.com/E3SM-Project/EKAT/blob/master/.github/CONTRIBUTING.md)\nif you are interested in contributing to EKAT.\n\nThis project is licensed under the terms of the BOOST license. See LICENSE.txt for details.\n\n# Overview\n\nDespite being first created with the goal of being a common implementation for common Kokkos-related kernels,\nEKAT evolved to contain a variety of C++ and CMake utilities. Here is a list of some of the utilities provided\nin EKAT.\n\n- C++ structures to enhance vectorization (Pack and Mask).\n- C++ structures for kernel-local scratch memory (Workspace).\n- C++ interface to read and store content of yaml files.\n- C++ routines for team-level solvers for diagonally dominant tridiagonal systems.\n- C++ routines for team-level efficient linear interpolation of 1d data.\n- Backport of some C++17 features (such as std::any), and several std-like meta-utilities.\n- CMake utilities for creating a suite of unit tests for multiple MPI/OpenMP rank/threads combinations.\n- CMake machine files to configure Kokkos for common architectures and threading framework.\n\n# Configuring EKAT\n\nEKAT uses CMake to generate the build system. To make life easier, we provide some machine files\nfor the setup of Kokkos properties, located in cmake/machine-files/kokkos. In particular, we provide\nmachine files for the architecture specs, as well as machine files for the threading framework.\nIn cmake/machine-files you can see some example o f how to combine architecture/threading machine\nfiles into a single one, which can later be used in your cmake configuration script.\n\nFor instance, the following `my-mach.cmake` file combines intel Skylake arch specs with a OpenMP theading backend.\n\n```\nset (EKAT_MACH_FILES_PATH /path/to/ekat-src/cmake/machine-files/kokkos)\ninclude (${EKAT_MACH_FILES_PATH}/openmp.cmake)\ninclude (${EKAT_MACH_FILES_PATH}/intel-skx.cmake)\n\n```\nAnd this `do-cmake.sh` script would configure EKAT for a debug build using the machine file above\n\n```\n#!/bin/bash\n\nSRC_DIR=${WORK_DIR}/libs/ekat/ekat-src/branch\nINSTALL_DIR=${WORK_DIR}/libs/ekat/ekat-install/branch\n\nrm -rf CMakeFiles\nrm -f  CMakeCache.txt\n\ncmake \\\n  -C /path/to/my-mach.cmake                         \\\n  \\\n  -D CMAKE_BUILD_TYPE:STRING=DEBUG                  \\\n  -D CMAKE_CXX_COMPILER:STRING=g++                  \\\n  -D CMAKE_Fortran_COMPILER:STRING=gfortran         \\\n  -D CMAKE_INSTALL_PREFIX:PATH=${INSTALL_DIR}       \\\n  \\\n  -D EKAT_DISABLE_TPL_WARNINGS:BOOL=ON              \\\n  \\\n  -D EKAT_ENABLE_TESTS:BOOL=ON                      \\\n  -D EKAT_TEST_DOUBLE_PRECISION:BOOL=ON             \\\n  -D EKAT_TEST_SINGLE_PRECISION:BOOL=ON             \\\n  -D EKAT_TEST_MAX_THREADS:STRING=8                 \\\n  \\\n  ${SRC_DIR}\n```\n\nHere are some of EKAT's cmake config options:\n\n- EKAT_ENABLE_TESTS: enables ekat testing\n- EKAT_TEST_[DOUBLE|SINGLE]_PRECISION: whether to test single and/or double precision.\n- EKAT_TEST_MAX_[THREADS|RANKS]: maximum number of threads/ranks to use in unit tests\n- EKAT_TEST_THREADS_INC: increment in number of threads for each test.\n- EKAT_DEFAULT_BFB: in certain kernels, whether to default to a BFB, serialized, implementation.\n- EKAT_DISABLE_TPL_WARNINGS: whether warnings from TPLs should be disabled.\n- EKAT_ENABLE_VALGRIND: whether tests should be run through valgrind.\n- EKAT_ENABLE_CUDA_MEMCHECK: whether tests should be run through cuda-memcheck.\n- EKAT_ENABLE_COVERAGE: whether to enable code coverage in the compiler.\n\nOnce CMake configuration has completed, you can build and test EKAT with the usual `make` and `ctest` commands.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fe3sm-project%2Fekat","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fe3sm-project%2Fekat","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fe3sm-project%2Fekat/lists"}