FindEnvModules

Определяет реализацию модуля среды и делает команды доступными для скриптов CMake для их использования. Совместимо как с основанными на Lua модулями Lmod, так и с основанными на TCL модулями EnvironmentModules.

Этот модуль предназначен для использования в сценариях CTest Script (ctest -S). Также может использоваться в скриптах CMake (cmake -P).

Пример использования

set(CTEST_BUILD_NAME "CrayLinux-CrayPE-Cray-dynamic")
set(CTEST_BUILD_CONFIGURATION Release)
set(CTEST_BUILD_FLAGS "-k -j8")
set(CTEST_CMAKE_GENERATOR "Unix Makefiles")

...

find_package(EnvModules REQUIRED)

env_module(purge)
env_module(load modules)
env_module(load craype)
env_module(load PrgEnv-cray)
env_module(load craype-knl)
env_module(load cray-mpich)
env_module(load cray-libsci)

set(ENV{CRAYPE_LINK_TYPE} dynamic)

...

Переменные результата

Этот модуль установит следующие переменные в вашем проекте:

EnvModules_FOUND

Истина, если был найден совместимый фреймворк модулей среды.

Переменные кэша

Будет установлена следующая переменная кэша:

EnvModules_COMMAND

Команда модуля низкого уровня для использования. В настоящее время поддерживаются реализации на базе Lua (Lmod) и TCL (EnvironmentModules).

Переменные среды

ENV{MODULESHOME}

Обычно устанавливается реализацией модуля среды, используется как подсказка для поиска команды модуля для выполнения.

Предоставленные функции

Это определяет следующие функции CMake для взаимодействия с модулями среды:

env_module

Выполняет произвольную команду модуля:

env_module(cmd arg1 ... argN)
env_module(
  COMMAND cmd arg1 ... argN
  [OUTPUT_VARIABLE <out-var>]
  [RESULT_VARIABLE <ret-var>]
)

Параметры:

cmd arg1 ... argN

Подкоманда модуля и аргументы для выполнения так, как если бы они были переданы непосредственно команде модуля в вашей оболочке.

OUTPUT_VARIABLE <out-var>

Стандартный вывод от выполнения команды модуля.

RESULT_VARIABLE <ret-var>

Код возврата от выполнения команды модуля.

env_module_swap

Заменяет один модуль другим:

env_module_swap(out_mod in_mod
  [OUTPUT_VARIABLE <out-var>]
  [RESULT_VARIABLE <ret-var>]
)

Функционально эквивалентно команде оболочки module swap out_mod in_mod. Параметры:

OUTPUT_VARIABLE <out-var>

Стандартный вывод от выполнения команды модуля.

RESULT_VARIABLE <ret-var>

Код возврата от выполнения команды модуля.

env_module_list

Возвращает список загруженных модулей:

env_module_list(<out-var>)

Функционально эквивалентно команде оболочки module list. Результат сохраняется в <out-var> в виде отформатированной переменной CMake список, разделённый точкой с запятой.

env_module_avail

Возвращает список доступных модулей:

env_module_avail([<mod-prefix>] <out-var>)

Функционально эквивалентно команде оболочки module avail <mod-prefix>. Результат сохраняется в <out-var> в виде отформатированной переменной CMake список, разделённый точкой с запятой.