KALMUS

Калмус

Kalmus - это пакет Python для вычислительного анализа цветов в пленках. Он предоставляет количественные инструменты для изучения и сравнения использования цвета пленки. Этот пакет служит двум целям: (1) Различные способы измерения, расчета и сравнения цветов пленки и (2) различных способов визуализации цвета пленки. Мы назвали программное обеспечение Калмуса в честь Натали Калмуса (1882 - 1965), директора техниколора, который курировал цветовые палитры почти 300 голливудских художественных фильмов.

Калмус использует штрих -код фильма в качестве визуализации цвета фильма. Он имеет модульный конвейер для генерации штрих -кодов, использующих различные показатели цвета и область интереса в каждой раме пленки. Kalmus предоставляет API низкого уровня, командную строку высокого уровня и графический интерфейс пользователя для аудитории из всех фонов, чтобы воспользоваться его функциональностью.

• Что такое штрих -код фильма: Калмус: Инструменты для анализа цвета фильмов. Журнал программного обеспечения с открытым исходным кодом , 6 (61), 3156. https://doi.org/10.21105/joss.03156
• Как установить руководство по установке Kalmus: Kalmus и домашняя страница Kalmus pypi.
• Как я могу использовать учебники Kalmus: ноутбук для API, GUI и CLI Kalmus
• Как мне внести свой вклад в Руководство по вкладу Калмуса: Калмус
• Как мне запустить автоматический тестовый набор Kalmus: Auomated Test Suite

Примеры визуализации штрих -кода:

Рисунок 1. Миссия: невозможный (1996) Цветовой штрих


Рисунок 2. Миссия: невозможный (1996) Цветной штрих -код с использованием среднего цвета переднего плана каждого кадра

Документация API

Ссылка на API Kalmus теперь доступна на https://kalmus-color-toolkit.github.io/kalmus/kalmus.html.

Руководство по установке

Пакет Kalmus требует Python с версией 3.7 или 3.8.

Пакет выпущен на PYPI (Project HomePage). После установки Python == 3.7, 3.8, вы можете установить Kalmus с помощью PIP (рекомендуется)

 $ pip install kalmus

В качестве альтернативы, вы можете установить Kalmus локально, сначала клонируя этот репозиточный репо. Затем перейдите к верхнему каталогу клонированной папки проекта Kalmus и установите, используя команду PIP

 $ pip install .

В обоих методах зависимости пакета будут автоматически установлены. Вы можете проверить, был ли Kalmus установлен в вашей среде, используя команду PIP

 $ pip show kalmus

В качестве альтернативы, в версии 1.3.7 и выше, вы можете проверить версию установленного Kalmus, используя его атрибут .__version__ .

 >>> import kalmus
>>> print(kalmus.__version__) # Warning: The __version__ attribute is not available in the kalmus v.1.3.6 and backward
>>> 1.3.7 

Для пользователей с Apple M1 Chip (архитектура ARM64)

Как упоминал @elektrobohemian в выпуске № 4, Калмус не может накапливаться на процессорах Apple M1 из -за зависимости Калмуса от Numpy. Вы можете установить Kalmus под эмуляцией розетты с Python 3.7.

Начните

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

Чтобы начать с Калмуса, мы рекомендуем вам проверить учебные пособия по ноутбуке Jupyter в папке ноутбуков. Мы предоставляем интерактивные учебники для ноутбуков для пользователей, чтобы начать работу на Kalmus, используя свой API, GUI и CLI. Обратите внимание, что интерфейс командной строки (CLI) доступен только в Kalmus V1.3.7 или дальше.

• Учебное пособие по ноутбуку для графического пользовательского интерфейса
• Учебное пособие по графическому пользовательскому интерфейсу
• Учебное пособие по ноутбуку для интерфейса программирования приложений
• Учебное пособие по маркетингу для интерфейса командной строки
• Учебное пособие по ноутбуку для расширенного использования API

Вклад

Мы поощряем вклад, включая исправления ошибок и новые функции, от пользователей нашего сообщества. Внесение вклад в пакет Kalmus, пожалуйста, свяжитесь с сопровождающими проекта по электронной почте [email protected] или откройте проблему. Если ваши ошибки исправления или новые функции изменяют текущее поведение пакета, укажите изменения и причины в обсуждении с активаторами проекта.

Мы поощряем инклюзивную и дружелюбную дискуссию. Пожалуйста, следуйте нашему кодексу поведения при общении.

Тестовый набор

Мы предоставляем автоматический набор тестов, который охватывает основную функциональность Калмуса. Перед запуском автоматического тестового набора локально убедитесь, что вы установили последние версии Pytest, Pytest-Cov и Kalmus, и вы клонировали репозиторий проекта на главной ветви.

Чтобы запустить тестовый набор:

• Перейдите в верхний каталог клонированного проекта Kalmus
• Используйте команду $ python -m pytest tests --cov=kalmus --cov-config=.coveragerc --cov-report term-missing

См. Руководство для тестового набора для более подробной информации.

Цитирование

Если вы обнаружите, что наше программное обеспечение полезно в вашей работе, пожалуйста, укажите нашу статью, которая описывает использование Kalmus в анализе цветов пленки. Doi: https://doi.org/10.21105/joss.03156

Chen et al., (2021). Калмус: Инструменты для анализа цвета фильмов. Журнал программного обеспечения с открытым исходным кодом, 6 (61), 3156, https://doi.org/10.21105/joss.03156

Вот бибтексовое цитирование нашей работы:

 @article{Chen2021,
    doi = {10.21105/joss.03156},
    url = {https://doi.org/10.21105/joss.03156},
    year = {2021},
    volume = {6},
    number = {61},
    pages = {3156},
    author = {Yida Chen and Eric Faden and Nathan C. Ryan},
    title = {KALMUS: tools for color analysis of films},
    journal = {Journal of Open Source Software}
}

Подтверждение

Авторы хотели бы поблагодарить Фонд Меллона, Фонд семьи Далал и Гумантского центра Бакнелла за поддержку в этом проекте. Проект выпущен по лицензии с открытым исходным кодом.

Обновление журнала

Полное журнал обновления (от V1.3.0 до V1.3.14) теперь доступен на https://kalmus-color-toolkit.github.io/kalmus/update_log.html