Руководство по быстрому старту для участников#

После получение исходного кода из GitHub, есть три шага, чтобы начать вносить вклад:

  1. Настройка среды разработки

    Используя mamba, или с помощью одного из множества инструментов управления виртуальными окружениями, вы можете убедиться, что версия SciPy для разработки не мешает другим локальным установкам SciPy на вашем компьютере.

  2. Сборка SciPy

    SciPy использует скомпилированный код для скорости, что означает, что вам могут потребоваться дополнительные зависимости для завершения этого шага в зависимости от вашей системы - см. Сборка из исходного кода.

  3. Выполнение задач разработки

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

Базовый рабочий процесс#

Примечание

Мы сильно рекомендуется использовать пользовательскую активированную среду, такую как conda или виртуальное окружение.

Поскольку SciPy содержит части, написанные на C, C++ и Fortran, которые необходимо скомпилировать перед использованием, убедитесь, что у вас установлены необходимые компиляторы и заголовки разработки Python. Если вы используете mamba, они будут установлены автоматически. Если вы используете pip, проверьте, какой зависимости на уровне системы возможно, потребуется.

Сначала создайте форк основной репозитории SciPy в GitHub на свой собственный аккаунт, а затем создайте локальный репозиторий через:

git clone git@github.com:YOURUSERNAME/scipy.git scipy
cd scipy
git submodule update --init
git remote add upstream https://github.com/scipy/scipy.git

Далее настройте вашу среду разработки. С зависимости на уровне системы установлен, выполните инструкции в Сборка из исходного кода.

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

Другие рабочие процессы#

Существует множество способов настроить среду разработки. Для более подробных инструкций см. Руководство для участников SciPy.

Примечание

Если у вас возникают трудности со сборкой SciPy из исходного кода или настройкой локальной среды разработки, вы можете попробовать собрать SciPy с помощью GitHub Codespaces. Это позволяет создать правильную среду разработки прямо в браузере, уменьшая необходимость установки локальных сред разработки и решения проблем с несовместимыми зависимостями.

Если у вас хорошее интернет-соединение и нужна временная настройка, часто быстрее работать над SciPy в среде Codespaces. Для документации о том, как начать работу с Codespaces, см. документация Codespaces. При создании кодового пространства для scipy/scipy репозитории, тип машины по умолчанию с 2 ядрами работает; 4-ядерный будет собираться и работать немного быстрее (но, конечно, за счет сокращения количества бесплатных часов использования вдвое). После запуска вашего codespace вы можете запустить conda activate scipy-dev и ваша среда разработки полностью настроена - вы можете затем следовать соответствующим разделам документации SciPy для сборки, тестирования, разработки, написания документации и внесения вклада в SciPy.

Другой альтернативой является использование Gitpod. Мы больше не поддерживаем это решение, но некоторая информация может быть найдена в предыдущих версиях нашего документация.