biopython
1.0.0
Проект Biopython — это международная ассоциация разработчиков свободно доступных инструментов Python для вычислительной молекулярной биологии.
Этот файл README предназначен в первую очередь для людей, заинтересованных в работе с исходным кодом Biopython, либо с одним из выпусков с веб-сайта http://biopython.org, либо из нашего репозитория на GitHub https://github.com/biopython/biopython.
Наша ориентированная на пользователя документация, Учебное пособие и кулинарная книга по Biopython, а также документация по API создаются из нашего репозитория с использованием Sphinx.
В файле NEWS суммируются изменения в каждой версии Biopython, а также в файле DEPRECATED, в котором отмечаются сбои API.
Пакет Biopython — это программное обеспечение с открытым исходным кодом, доступное на льготных условиях. Дополнительную информацию см. в файле ЛИЦЕНЗИИ.
Если вы используете Biopython в работе над научной публикацией, мы просим вас процитировать наши рекомендации по применению (ниже) или одну из публикаций по конкретному модулю (перечисленных на нашем веб-сайте):
Кок, PJA и др. Biopython: свободно доступные инструменты Python для вычислительной молекулярной биологии и биоинформатики. Биоинформатика 2009 1 июня; 25(11) 1422-3 https://doi.org/10.1093/bioinformatics/btp163 pmid:19304878
Python включает в себя систему управления пакетами «pip», которая позволит вам установить Biopython (и его зависимость NumPy, если необходимо), обновить или удалить с помощью всего лишь одной команды терминала:
pip установить биопитон pip install --upgrade biopython pip удалить биопитон
Начиная с Biopython 1.70, мы предоставляем предварительно скомпилированные двоичные пакеты колес на PyPI для Linux, macOS и Windows. Это означает, что установка pip должна быть быстрой и не требовать компилятора.
Как разработчик или потенциальный участник вы можете загрузить, собрать и установить Biopython самостоятельно. Это описано ниже.
В настоящее время мы рекомендуем использовать Python 3.11 с http://www.python.org.
Biopython в настоящее время поддерживается и тестируется в следующих реализациях Python:
Для Biopython требуется NumPy (см. http://www.numpy.org), который будет установлен автоматически, если вы установите Biopython с помощью pip (см. ниже, чтобы самостоятельно скомпилировать Biopython).
В зависимости от того, какие части Biopython вы планируете использовать, существует ряд других дополнительных зависимостей Python, которые при необходимости можно установить позже:
Bio.Graphics , поэтому, если вам не нужна эта функциональность, вам не нужно будет устанавливать этот пакет.Bio.Phylo использует этот пакет для построения филогенетических деревьев.Bio.Phylo .Bio.Phylo .BioSQL для доступа к базе данных PostgreSQL.BioSQL для доступа к базе данных MySQL, а также поддерживается в PyPy.BioSQL для доступа к базе данных MySQL. Он поддерживается PyPy.Кроме того, вы можете установить ряд полезных сторонних инструментов, таких как автономные NCBI BLAST, EMBOSS или ClustalW.
Мы рекомендуем использовать предварительно скомпилированные двоичные колеса, доступные в PyPI, используя:
pip установить биопитон
Однако, если вам нужно скомпилировать Biopython самостоятельно, во время компиляции потребуется следующее:
Python, включая файлы заголовков разработки, такие как python.h , которые в Linux часто не устанавливаются по умолчанию (попытка найти и установить пакет с именем python-dev или python-devel , а также пакет python ).
Подходящий компилятор C для вашей версии Python, например GCC в Linux, MSVC в Windows. Для Mac OS X или, как ее теперь называют, macOS, используйте инструменты командной строки Apple, которые можно установить с помощью команды терминала:
xcode-select --install
Будет предложено установить пакет разработки Apple XCode — можно, но он не нужен и занимает много места на диске.
Затем либо загрузите и распакуйте наш исходный код, либо получите его с помощью git. Теперь перейдите в папку с исходным кодом Biopython и запустите:
пип установить -e . тест python setup.py установка sudo python setup.py
При необходимости замените python на свою конкретную версию, например python3 или pypy3 .
Чтобы исключить тесты, требующие подключения к Интернету (и которые могут занять много времени), используйте опцию --offline :
тест python setup.py --оффлайн
Если вам нужно выполнить дополнительную настройку, например изменить префикс каталога установки, введите python setup.py .
Biopython включает набор регрессионных тестов, позволяющих проверить, все ли работает правильно. Чтобы запустить тесты, перейдите в каталог исходного кода biopython и введите:
пип установить -e . тест python setup.py
Если вы хотите пропустить онлайн-тесты (что рекомендуется при повторном тестировании), используйте:
тест python setup.py --оффлайн
Не паникуйте, если увидите сообщения, предупреждающие о пропущенных тестах:
test_DocSQL... пропускаем. Установите MySQLdb, если вы хотите использовать Bio.DocSQL.
Скорее всего это означает, что пакет не установлен. Вы можете игнорировать это, если оно встречается в тестах модуля, который вы не планировали использовать. Если вы действительно хотите использовать этот модуль, установите необходимую зависимость и повторно запустите тесты.
Некоторые тесты могут завершиться неудачно из-за проблем с сетью, часто это происходит случайно или из-за сбоя в обслуживании. Если проблема не исчезнет при повторном запуске тестов, вы можете использовать опцию --offline .
Дополнительную информацию о тестировании можно найти в Учебном руководстве и кулинарной книге Biopython.
В Biopython 1.61 появилось новое предупреждение Bio.BiopythonExperimentalWarning , которое используется для обозначения любого экспериментального кода, включенного в стабильные выпуски Biopython. Такой код уровня «бета» готов к более широкому тестированию, но, скорее всего, изменится, и его следует опробовать только ранним пользователям, чтобы оставить отзыв через список рассылки biopython-dev.
Мы ожидаем, что такой экспериментальный код достигнет стабильного статуса в течение одного или двух выпусков, после чего будут применяться наши обычные правила сохранения обратной совместимости.
Пока мы пытаемся выпустить надежный пакет, неизбежно возникают ошибки. Если у вас возникли проблемы, которые могут быть вызваны ошибкой в Biopython, возможно, она уже обнаружена. Обновите последнюю версию, если вы ее еще не используете, и повторите попытку. Если проблема не устранена, просмотрите нашу базу данных ошибок и списки рассылки, чтобы узнать, сообщалось ли об этой ошибке (и, надеюсь, исправлено), а если нет, сообщите об ошибке. Мы не можем решить проблемы, о которых не знаем ;)
Отслеживание проблем: https://github.com/biopython/biopython/issues.
Если вы подозреваете, что проблема кроется в анализаторе, вполне вероятно, что формат данных изменился, что привело к поломке кода синтаксического анализа. (Текстовые форматы BLAST и GenBank кажутся особенно хрупкими.) Таким образом, код синтаксического анализа в Biopython иногда обновляется быстрее, чем мы можем создавать выпуски Biopython. Вы можете получить самую последнюю версию парсера, вытащив соответствующие файлы (например, в Bio.SeqIO или Bio.Blast ) из нашего репозитория git. Однако будьте осторожны при этом, поскольку код на github не так хорошо протестирован, как выпущенный код, и может содержать новые зависимости.
В любом отчете об ошибке сообщите нам:
А еще в идеале:
Biopython управляется волонтерами со всего мира с разным опытом. Мы всегда ищем людей, заинтересованных в помощи в разработке кода, управлении веб-сайтами, написании документации, техническом администрировании и во всем остальном.
Если вы хотите внести свой вклад, сначала прочтите CONTRIBUTING.st здесь, посетите наш веб-сайт http://biopython.org и присоединитесь к нашему списку рассылки: http://biopython.org/wiki/Mailing_lists
README.rst -- Этот файл.NEWS.rst — Примечания к выпуску и новости.LICENSE.rst — Что вы можете делать с кодом.CONTRIB.rst — (неполный) список людей, которые так или иначе помогли Biopython.CONTRIBUTING.rst — обзор того, как внести свой вклад в Biopython.DEPRECATED.rst — содержит информацию о модулях Biopython, которые были удалены или больше не рекомендуются для использования, а также о том, как обновить код, использующий эти модули.MANIFEST.in — определяет, какие файлы включать в выпуски.setup.py — установочный файл.Bio/ -- Основной базовый код кода.BioSQL/ — код для использования Biopython с базами данных BioSQL.Doc/ -- Документация.Scripts/ — разные, возможно полезные, автономные скрипты.Tests/ — код регрессионного тестирования, включая примеры файлов данных.
