Установка

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

Быстрый старт

Сборка бинарного Python-колеса

Чтобы сгенерировать бинарные колёса MindQuantum, мы рекомендуем использовать пакет build от Pypa:

cd mindquantum
python3 -m build .

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

Делокация колёс

Чтобы убедиться, что все необходимые внешние зависимости библиотек содержатся в файле бинарного колеса, вы можете указать процессу сборки бинарных колёс делоцировать созданные колёса. На практике это означает удаление любой зависимости от внешних (общих) библиотек в вашей системе путём интеграции их непосредственно в бинарное колесо.

Использование cibuildwheel

Это предпочтительный способ создания бинарных колес, поскольку он опирается на образы Docker (только для Linux) или стандартную версию Python для MacOS и Windows.

cd mindquantum
python3 -m cibuildwheel .

Возможно, вам потребуется указать свою платформу, если cibuildwheel не может автоматически определить вашу платформу или если вы хотите собрать Linux-колесо на MacOS, например:

cd mindquantum
python3 -m cibuildwheel --platform linux .

См. python3 -m cibuildwheel --help, чтобы узнать, какие платформы доступны.

Linux

В Linux вы можете запустить скрипт прямо на любом компьютере, так как он использует образы Docker для сборки делоцированного бинарного колеса. То же самое относится к MacOS или Windows, если вы хотите создать Linux-бинарные колеса.

MacOS

На MacOS cibuildwheel установит официальную версию Python на вашем компьютере перед сборкой бинарного колеса. Это делает запуск скрипта на вашей машине разработки нецелесообразным, если только вы не понимаете, что делаете.

Windows

На Windows cibuildwheel установит официальную версию Python с помощью NuGet на вашем компьютере перед сборкой бинарного колеса. Это делает запуск скрипта на вашей машине разработки нецелесообразным, если только вы не понимаете, что делаете.

На вашем локальном компьютере

Если вы не хотите полагаться на механизм cibuildwheel (например, на MacOS), вы также можете автоматически вызывать auditwheel или delocate после сборки колеса, указав переменную среды MQ_DELOCATE_WHEEL, например:

cd mindquantum
MQ_DELOCATE_WHEEL=1 python3 -m build .

Если вы планируете распространять колесо другим людям, у которых может быть другая система, чем у вас, мы настоятельно рекомендуем попробовать указать переменную среды MQ_DELOCATE_WHEEL_PLAT. По умолчанию сценарии установки предполагают 'linux_x86_64' на 64-битных машинах, но вы можете указать любые платформы, поддерживаемые auditwheel. Чтобы распространить ваши колеса среди более широкой аудитории, мы бы рекомендовали установить MQ_DELOCATE_WHEEL_PLAT=manylinux2010_x86_64, хотя это может привести к ошибке при делокации колеса, если версия вашего компилятора слишком свежая.

Соберите MindQuantum локально

Вы можете настроить MindQuantum для локальной разработки, используя один из локальных сценариев сборки:

• build_locally.bat (сценарий MS-DOS BATCH)
• build_locally.ps1 (скрипт PowerShell)
• build_locally.sh (скрипт Bash)

За исключением нескольких незначительных различий [1]_, функциональность всех трех сценариев идентична. Все сценарии принимают флаг для отображения справочного сообщения (-h, --help, -H, -Help, /h, /Help для Bash, PowerShell и MS-DOS BATCH). Пожалуйста, запустите сценарий по вашему выбору, чтобы просмотреть последний набор предоставляемых им функций.

1. Настройка виртуальной среды Python
2. Обновление пакетов виртуальной среды и установка некоторых необходимых зависимостей
3. Добавление PTH-файла в виртуальную среду Python, чтобы убедиться, что MindQuantum будет обнаружен
4. Создание каталога сборки и запуск CMake внутри него
5. Компиляция MindQuantum на месте Те, которые необходимы в данный момент, на основе хешей сторонних библиотек.

DISABLE_FORTRAN_COMPILER

В настоящее время это влияет только на установку Eigen3.

Переменные CMake

Помимо вышеуказанных опций CMake, вы можете передать определённые специальные переменные CMake для настройки сборки. Они подробно описаны ниже.

MQ_FORCE_LOCAL_PKGS

Значение этой переменной нечувствительно к регистру. Оно может быть:

— одной строкой (all);

— списком имён пакетов CMake через запятую для одной или нескольких сторонних зависимостей MindQuantum (например, gmp,eigen3).

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

MQ_XXX_FORCE_LOCAL

Установка этого значения в истинное значение для одной из сторонних зависимостей MindQuantum приведёт к тому, что этот пакет будет скомпилирован локально во время процесса настройки CMake. Обратите внимание, что имя пакета XXX должно быть написано заглавными буквами.