1.1. Поддерживаемые платформы

• Windows 64-разрядная на процессорах x86
• macOS на процессорах x86 и ARM (M1 и т.д.)
• Linux 64-разрядная на процессорах x86 и ARM

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

1.2. Проверка версии

Чтобы узнать, установлена ли уже scikit-image, или проверить, прошла ли установка успешно, выполните следующее в оболочке Python или Jupyter Notebook:

import skimage as ski
print(ski.__version__)

или, из командной строки:

python -c "import skimage; print(skimage.__version__)"

(Попробуйте python3, если python не удастся.)

Вы увидите номер версии, если scikit-image установлена, и сообщение об ошибке в противном случае.

1.3. Установка с помощью pip и conda

# Update pip
python -m pip install -U pip

# Install scikit-image
python -m pip install -U scikit-image

python -m pip install -U scikit-image[data]

python -m pip install -U scikit-image[optional]

conda install scikit-image

1.4. Управляющие программы системных пакетов

Использование менеджера пакетов (apt, dnf, и т.д.) для установки scikit-image или других пакетов Python не является лучшим вариантом, так как вы, скорее всего, получите более старую версию. Также становится сложнее установить другие пакеты Python, не предоставляемые менеджером пакетов.

1.5. Загрузка всех демонстрационных наборов данных

Некоторые наши примерные изображения (в skimage.data) размещены в Интернете и не устанавливаются по умолчанию. Эти изображения загружаются при первом доступе. Если вы предпочитаете загрузить все демонстрационные наборы данных, чтобы к ним можно было получить доступ автономно, убедитесь, что pooch установлен, а затем выполните:

python -c 'import skimage as ski; ski.data.download_all()'

1.6. Дополнительная помощь

Если у вас остались вопросы, обратитесь к

• нашему форуму пользователей
• нашему форуму разработчиков
• нашему каналу чата

Чтобы предложить изменение в этих инструкциях, отправьте запрос на GitHub.

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

Настройте среду разработки Python, настроенную для scikit-image. Здесь мы предоставляем инструкции для двух популярных менеджеров сред: venv (pip) и conda (miniforge).

# Create a virtualenv named ``skimage-dev`` that lives outside of the repository.
# One common convention is to place it inside an ``envs`` directory under your home directory:
mkdir ~/envs
python -m venv ~/envs/skimage-dev

# Activate it
# (On Windows, use ``skimage-dev\Scripts\activate``)
source ~/envs/skimage-dev/bin/activate

# Install development dependencies
pip install -r requirements.txt
pip install -r requirements/build.txt

# Install scikit-image in editable mode. In editable mode,
# scikit-image will be recompiled, as necessary, on import.
spin install -v

spin build

# Create a conda environment named ``skimage-dev``
conda create --name skimage-dev

# Activate it
conda activate skimage-dev

# Install development dependencies
conda install -c conda-forge --file requirements/default.txt
conda install -c conda-forge --file requirements/test.txt
conda install -c conda-forge pre-commit ipython
conda install -c conda-forge --file requirements/build.txt

# Install scikit-image in editable mode. In editable mode,
# scikit-image will be recompiled, as necessary, on import.
spin install -v

spin build

2.2. Тестирование

Запустите полный набор тестов:

spin test

Или запустите подмножество тестов:

# Run tests in a given file
spin test skimage/morphology/tests/test_gray.py

# Run tests in a given directory
spin test skimage/morphology

# Run tests matching a given expression
spin test -- -k local_maxima

2.3. Добавление ветки функции

При добавлении новой функции делайте это через ветку функции.

Сначала получите последние исходники:

git switch main
git pull upstream main

Создайте вашу ветку функции:

git switch --create my-feature-name

Используя установку с редактированием, scikit-image будет перестраиваться по мере необходимости. Если вы выполняете сборку вручную, перестройте её с помощью:

.. code-block:: sh

spin build

Повторные, пошаговые сборки обычно работают нормально, но если вы заметите проблемы со сборкой, перестройте её с нуля с помощью:

spin build --clean

2.4. Примечания к конкретным платформам

Windows

Сборка scikit-image на Windows выполняется в рамках наших тестов непрерывной интеграции; шаги показаны в этом Azure Pipeline.

Debian и Ubuntu

Установите подходящие компиляторы перед компиляцией библиотеки:

sudo apt-get install build-essential

2.5. Полный список требований

Требования к сборке

# Generated via tools/generate_requirements.py and pre-commit hook.
# Do not edit this file; modify pyproject.toml instead.
meson-python>=0.16
setuptools>=68
ninja>=1.11.1.1
Cython>=3.0.8
pythran>=0.16
numpy>=2.0
spin==0.13
build>=1.2.1

Требования к работе

# Generated via tools/generate_requirements.py and pre-commit hook.
# Do not edit this file; modify pyproject.toml instead.
numpy>=1.24
scipy>=1.11.2
networkx>=3.0
pillow>=10.1
imageio>=2.33,!=2.35.0
tifffile>=2022.8.12
packaging>=21
lazy-loader>=0.4

Требования к тестированию

# Generated via tools/generate_requirements.py and pre-commit hook.
# Do not edit this file; modify pyproject.toml instead.
asv
numpydoc>=1.7
pooch>=1.6.0
pytest>=7.0
pytest-cov>=2.11.0
pytest-localserver
pytest-faulthandler
pytest-doctestplus

Требования к документации

# Generated via tools/generate_requirements.py and pre-commit hook.
# Do not edit this file; modify pyproject.toml instead.
sphinx>=8.0
sphinx-gallery[parallel]>=0.18
numpydoc>=1.7
sphinx-copybutton
matplotlib>=3.7
dask[array]>=2022.9.2
pandas>=2.0
seaborn>=0.11
pooch>=1.6
tifffile>=2022.8.12
myst-parser
intersphinx-registry>=0.2411.14
ipywidgets
ipykernel
plotly>=5.20
kaleido==0.2.1
scikit-learn>=1.2
sphinx_design>=0.5
pydata-sphinx-theme>=0.16
PyWavelets>=1.6
pytest-doctestplus

Требования к разработчикам

# Generated via tools/generate_requirements.py and pre-commit hook.
# Do not edit this file; modify pyproject.toml instead.
pre-commit
ipython
tomli; python_version < '3.11'

Требования к данным

Полный набор демонстрационных наборов данных доступен только при установке:

# Generated via tools/generate_requirements.py and pre-commit hook.
# Do not edit this file; modify pyproject.toml instead.
pooch>=1.6.0

Дополнительные требования

Вы можете использовать scikit-image с базовыми требованиями, перечисленными выше, но некоторые функции доступны только при установке:

• Matplotlib Используется в различных функциях, например, для рисования, сегментирования, чтения изображений.
• Dask Модуль dask используется для распараллеливания определённых функций.

Реже вам могут понадобиться:

• PyAMG Модуль pyamg используется для быстрого cg_mg режима сегментации случайного блуждания.
• Astropy Предоставляет возможность ввода-вывода FITS.
• SimpleITK Необязательный плагин ввода-вывода, предоставляющий широкий спектр форматов, включая специализированные форматы, используемые в биомедицинской визуализации.

# Generated via tools/generate_requirements.py and pre-commit hook.
# Do not edit this file; modify pyproject.toml instead.
SimpleITK
astropy>=5.0
cloudpickle>=0.2.1
dask[array]>=2021.1.0,!=2024.8.0
matplotlib>=3.7
pooch>=1.6.0
pyamg>=5.2
PyWavelets>=1.6
scikit-learn>=1.2

2.6. Помощь с установкой для участников

См. Дополнительную помощь выше.