Сценарий сборки проекта платформы или прикладного решения на C++

Вы можете собрать платформу или прикладное решение на C++ из исходного кода. Для сборки прикладного решения вы можете добавить платформу как зависимость с помощью функции add_subdirectory в CMake или с помощью менеджера зависимостей (например, CPM.cmake).

При разработке прикладных решений на Linux вы можете установить нужные deb-пакеты вместо сборки прикладного решения.

На компьютере должно быть установлено программное обеспечение, которое указано в аппаратных и программных требованиях.

Сборку под Linux вы можете выполнить в Docker-контейнере. Для этого вы можете использовать Docker-образ knp-build-image, входящий в комплект поставки платформы.

Сценарий сборки платформы или прикладного решения состоит из следующих этапов:

1. Подготовка к сборке

   Получите исходный код платформы. Вы можете получить исходный код платформы одним из следующих способов:

   • Склонировать репозиторий платформы.
   • Скачать архив с исходным кодом из репозитория платформы и распаковать его в рабочую директорию.

   После получения исходного кода платформы установите библиотеку Boost нужной версии.

   При работе в ОС Windows рекомендуется установить библиотеку, скомпилированную предварительно для Visual Studio. Например, для Visual Studio 2022 версия компилятора – 14.3. Соответственно для установки библиотеки Boost, скомпилированной для Visual Studio, необходимо скачать исполняемый файл с именем в формате boost_<версия Boost>-msvc-14.3-<разрядность ОС Windows>.exe.

2. Конфигурация сборки платформы

   В ОС Windows для CMake необходимо указать директорию, в которой установлена библиотека Boost. Вы можете это сделать одним из следующих способов:

   • Указать путь к установленной библиотеке Boost в параметре Boost_ROOT в файле CMakePresets.json, расположенном в корневой директории с исходным кодом платформы.

     CMake кеширует значения переменных. Если после определения параметра Boost_ROOT CMake не может найти библиотеку Boost, необходимо заново сгенерировать кеш CMake.

   • Создать переменную окружения Boost_ROOT.
   • Определить путь к установленной библиотеке Boost как параметр вызова CMake. Для этого при конфигурации сборки используйте следующий параметр:

     -DBOOST_ROOT=<путь к установленной библиотеке Boost>

   В случае сборки платформы с Python-фреймворком изучите особенности сборки.

   Если вы собираете платформу на Linux, выполните конфигурацию сборки с помощью системы сборки CMake. Например, вы можете использовать следующую команду:

   cmake -S. -Bbuild --preset <пресет для сборки> -DCMAKE_C_COMPILER=<компилятор> -DCMAKE_CXX_COMPILER=<компилятор>

   где:

   • <пресет для сборки> – имя файла пресета, описывающего параметры сборки.

     Вы можете указать один из пресетов, описанных в файле CMakePresets.json, расположенном в корневой директории с исходным кодом платформы. Описание пресетов, предоставляемых Kaspersky Neuromorphic Platform, см. в Приложении.

     Опция --preset <пресет для сборки> при выполнении конфигурации сборки не является обязательной.

   • <компилятор> – компиляторы для языка программирования C и C++.

   При конфигурации сборки вы можете задать параметры конфигурации платформы.

   Подробнее о конфигурации сборки с помощью CMake см. документацию CMake.

   Если вы собираете платформу в ОС Windows, выполните конфигурацию сборки в Visual Studio. Для этого откройте проект, выбрав нужный файл CMakeLists.txt, и выполните настройку кеша. Для сборки платформы необходимо выбрать файл CMakeLists.txt, расположенный в корневой директории с исходным кодом платформы.

   Первая конфигурация сборки с помощью CMake может выполняться долго и завершаться с сетевыми ошибками. В случае возникновения сетевых ошибок выполните конфигурацию сборки еще раз.

3. Запуск сборки платформы

   Запустите сборку платформы или прикладного решения. Подробнее о запуске сборки проектов см. документацию CMake или документацию используемой интегрированной среды разработки.

   Для запуска сборки на Linux вы можете использовать команду:

   cmake -B build .

   Для запуска сборки в ОС Windows в Visual Studio на вкладке Сборка выберите Собрать все.

4. Сборка прикладного решения

   Для сборки прикладного решения создайте файл CMakeLists.txt и опишите в нем процесс сборки. Добавьте платформу как зависимость, указав директорию с платформой с помощью функции add_subdirectory. Укажите исполняемый файл с помощью функции add_executable. Добавьте библиотеки платформы, которые необходимо подключить к проекту, с помощью функции target_link_libraries. Вы можете использовать следующие библиотеки:

   • neuron_traits
   • synapse_traits
   • core
   • meta
   • backends
   • framework

   Выполните конфигурацию сборки для прикладного решения. В случае сборки в ОС Windows при открытии проекта выберите файл CMakeLists.txt прикладного решения. Запустите сборку прикладного решения.