Biopython 計畫是一個國際計算分子生物學 Python 工具開發者協會。
此自述文件主要針對對使用Biopython 原始碼感興趣的人們,無論是來自http://biopython.org 網站的版本之一,還是來自我們在GitHub 上的儲存庫https://github.com/biopython/ biopython
我們以使用者為中心的文件、Biopython 教學和食譜以及 API 文件是使用 Sphinx 從我們的儲存庫產生的。
NEWS 檔案總結了 Biopython 每個版本的更改,以及記錄 API 損壞的 DEPRECATED 檔案。
Biopython 套件是開源軟體,以慷慨的條款提供。請參閱許可證文件以了解更多詳細資訊。
如果您在為科學出版物做出貢獻的工作中使用 Biopython,我們要求您引用我們的應用說明(如下)或模組特定出版物之一(在我們的網站上列出):
考克,PJA 等人。 Biopython:用於計算分子生物學和生物資訊學的免費 Python 工具。生物資訊學2009年6月1日; 25(11)1422-3 https://doi.org/10.1093/bioinformatics/btp163 pmid:19304878
Python 包含套件管理系統“pip”,它允許您安裝 Biopython(及其依賴項 NumPy,如果需要),只需一個終端命令即可升級或卸載:
pip安裝biopython pip install --升級biopython pip卸載biopython
從 Biopython 1.70 開始,我們在 PyPI 上為 Linux、macOS 和 Windows 提供了預先編譯的二進位輪包。這意味著 pip install 應該很快,並且不需要編譯器。
作為開發人員或潛在貢獻者,您可能希望自行下載、建置和安裝 Biopython。下面對此進行說明。
我們目前建議使用 http://www.python.org 中的 Python 3.11
Biopython 目前在以下 Python 實作上受支援和測試:
Biopython 需要 NumPy(請參閱 http://www.numpy.org),如果您使用 pip 安裝 Biopython(請參閱下文自行編譯 Biopython),則會自動安裝 NumPy。
根據您計劃使用 Biopython 的哪些部分,還有許多其他可選的 Python 依賴項,可以在需要時稍後安裝:
Bio.Graphics
中使用,因此如果您不需要此功能,則無需安裝此軟體包。Bio.Phylo
使用此套件來繪製系統發育樹。Bio.Phylo
中的某些利基功能。Bio.Phylo
下的 CDAO 解析器。BioSQL
使用這些套件來存取 PostgreSQL 資料庫。BioSQL
使用該套件來存取 MySQL 資料庫,PyPy 也支援該套件。BioSQL
使用它來存取 MySQL 資料庫。它由 PyPy 支援。此外,您可能想要安裝許多有用的第三方工具,例如獨立的 NCBI BLAST、EMBOSS 或 ClustalW。
我們建議使用 PyPI 上提供的預編譯二進位輪:
pip安裝biopython
但是,如果需要自己編譯Biopython,則編譯時需要滿足以下條件:
Python 包括像python.h
這樣的開發頭文件,在 Linux 上通常預設不會安裝這些文件(嘗試尋找並安裝名為python-dev
或python-devel
套件以及python
套件)。
適合您的 Python 版本的 C 編譯器,例如 Linux 上的 GCC、Windows 上的 MSVC。對於 Mac OS X,或現在的 macOS,使用 Apple 的命令列工具,可以使用終端命令安裝:
xcode-選擇--安裝
這將提供安裝 Apple 的 XCode 開發套件 - 您可以,但它不是必需的,並且會佔用大量磁碟空間。
然後下載並解壓縮我們的原始程式碼,或使用 git 來取得它。現在將目錄更改為 Biopython 原始碼資料夾並運行:
pip install -e 。 python setup.py 測試 sudo python setup.py 安裝
如果需要,請將python
替換為您的特定版本,例如python3
或pypy3
。
若要排除需要網路連線(並且可能需要很長時間)的測試,請使用--offline
選項:
python setup.py 測試 --offline
如果您需要進行其他配置,例如變更安裝目錄前綴,請輸入python setup.py
。
Biopython 包含一套回歸測試來檢查一切是否正常運作。要執行測試,請前往 biopython 原始碼目錄並輸入:
pip install -e 。 python setup.py 測試
如果您想跳過線上測試(在進行重複測試時建議這樣做),請使用:
python setup.py 測試 --offline
如果您看到跳過測試的警告訊息,請不要驚慌:
test_DocSQL ... 跳過。如果您想使用 Bio.DocSQL,請安裝 MySQLdb。
這很可能意味著未安裝軟體包。如果它發生在您不打算使用的模組的測試中,您可以忽略它。如果您確實想使用該模組,請安裝所需的依賴項並重新執行測試。
一些測試可能會因為網路問題而失敗,這通常是偶然的或服務中斷。如果重新執行測試後問題仍未消失,您可以使用--offline
選項。
Biopython 教學和食譜中有更多測試資訊。
Biopython 1.61 引入了一個新警告Bio.BiopythonExperimentalWarning
,它用於標記穩定 Biopython 版本中包含的任何實驗代碼。這種「beta」級程式碼已準備好進行更廣泛的測試,但仍然可能會發生變化,並且只能由早期採用者嘗試,以便透過 biopython-dev 郵件清單提供回饋。
我們希望此類實驗程式碼在一兩個版本內達到穩定狀態,此時我們關於嘗試保持向後相容性的正常策略將適用。
當我們嘗試提供一個強大的軟體包時,錯誤不可避免地會出現。如果您遇到的問題可能是由 Biopython 中的錯誤引起的,那麼它可能已經被識別出來。如果您尚未使用最新版本,請更新至最新版本,然後再試一次。如果問題仍然存在,請搜尋我們的錯誤資料庫和郵件清單以查看是否已報告(並希望已修復),如果沒有,請報告該錯誤。我們無法解決我們不知道的問題;)
問題追蹤器:https://github.com/biopython/biopython/issues
如果您懷疑問題出在解析器中,則資料格式可能已變更並破壞了解析程式碼。 (文本 BLAST 和 GenBank 格式似乎特別脆弱。)因此,Biopython 中的解析程式碼有時更新得比我們建立 Biopython 版本的速度更快。您可以從我們的 git 儲存庫中提取相關檔案(例如Bio.SeqIO
或Bio.Blast
中的檔案)來取得最新的解析器。但是,執行此操作時要小心,因為 github 中的程式碼沒有像已發布的程式碼那樣經過充分測試,並且可能包含新的依賴項。
在任何錯誤報告中,請告知我們:
而且理想情況下:
Biopython 由來自世界各地、具有多種背景的志工經營。我們一直在尋找有興趣幫助程式碼開發、網站管理、文件編寫、技術管理以及其他任何事情的人。
如果您想做出貢獻,請先閱讀此處的 CONTRIBUTING.rst,請造訪我們的網站 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/
-- 回歸測試程式碼,包含範例資料檔。