biopython – Biopythonの公式gitリポジトリ（CVSから変換）

Biopython READMEファイル

Biopythonプロジェクトは、計算上の分子生物学のために自由に利用できるPythonツールの開発者の国際協会です。

私たちのユーザー中心のドキュメントは、Biopythonの主なチュートリアルとクックブックを含むhttp://biopython.orgでホストされています。

• HTML – http://biopython.org/DIST/docs/tutorial/Tutorial.html
• PDF – http://biopython.org/DIST/docs/tutorial/Tutorial.pdf

このREADMEファイルは、主に、Biopythonソースコード、 http: //biopython.orgウェブサイトのリリース、またはGitHubのリポジトリhttps://github.com/biopython/biopythonのいずれかでの作業に興味がある人を対象としています

NEWSファイルには、Biopythonの各リリースの変更が要約されています。

Biopythonパッケージは、寛大な言葉で利用できるオープンソースのソフトウェアです。 詳細については、 LICENSEファイルを参照してください。

Biopythonを科学的な出版物に使用する作業で使用する場合は、アプリケーションノート（下記）またはモジュール特有の出版物（当社のウェブサイトに掲載）を引用してください。

Cock、PJA et al。 Biopython：計算分子生物学とバイオインフォマティクスのために自由に利用できるPythonツール。 バイオインフォマティクス2009年6月1日; 25（11）1422-3 http://dx.doi.org/10.1093/bioinformatics/btp163 pmid：19304878

辛抱強い

Python 2.7.9以降、Python 3.4以降には、パッケージ管理システム “pip”が含まれています。これにより、Biopython（および必要に応じて依存性のNumPy）をインストールできるようになり、1つの端末コマンドでアップグレードまたはアンインストールできます。

pip install biopython
pip install --upgrade biopython
pip uninstall biopython

Biopython 1.70以来、Linux、Mac OS X、Windows用のPyPI上でバイナリ・ホイール・パッケージをコンパイル済みで提供しています。 これは、pipのインストールが迅速で、コンパイラを必要としないことを意味します。

開発者または潜在的な貢献者として、Biopythonをダウンロード、ビルド、およびインストールすることをお勧めします。 これについては以下で説明します。

Pythonの要件

私たちは現在、 http: //www.python.orgのPython 3.6を使用することを推奨しています

Biopythonは現在、次のPython実装でサポートされ、テストされています：

• Python 2.7,3.4,3.5,3.6 – http://www.python.orgを参照してください。

  Python 3はBiopythonの主要開発プラットフォームです。 私たちは、Python 2.7のサポート終了日を2020年までに延期する予定です。

• PyPy v5.7およびPyPy3.5 v5.8 beta – http://www.pypy.orgを参照してください。

  Bio.trie （現在marshal.hが見つからないためコンパイルされません）以外はすべて動作します。 PyPyの古いバージョンもほとんどの場合動作します。

• Jython 2.7 – http://www.jython.orgを参照

  私たちはJythonのサポートを非難することに決めましたが、 Bio.Restriction 、Cコードを持つモジュール、またはSQLite3またはNumPyに依存するモジュールはすべて動作するはずです。 まだ解決されていないテスト失敗に関する既知の問題がいくつかあります。

Biopython 1.68は、Python 2.6をサポートするための最終リリースでした。

オプションの依存関係

BiopythonにはNumPy（ http://www.numpy.org参照 ）が必要です。これはpipでBiopythonをインストールした場合に自動的にインストールされます（Biopythonのコンパイルについては以下を参照してください）。

Biopythonのどの部分を使用するかに応じて、必要に応じて後でインストールすることができるその他のオプションのPython依存性がいくつかあります。

• ReportLab、 http://www.reportlab.com/opensource/ （オプション）このパッケージはBio.Graphicsでのみ使用されるため、この機能が必要ない場合はこのパッケージをインストールする必要はありません。
• matplotlib、 http: Bio.Phylo （オプション）を参照してください Bio.Phyloは系統樹をプロットするためにこのパッケージを使用します。
• networkx、 http: //networkx.lanl.gov/（オプション）、pygraphvizまたはpydot、 http: //networkx.lanl.gov/pygraphviz/およびhttp://code.google.com/p/pydot/ （オプション）これらのパッケージは、 Bio.Phylo特定のニッチ機能に使用されます。
• rdflib、 https://github.com/RDFLib/rdflib （省略可能）を参照してください。このパッケージは、Bio.PhyloのCDAOパーサーで使用されています。
• psycopg2、 http: //initd.org/psycopg/（オプション）、PyGreSQL（pgdb）、 http: //www.pygresql.org/（オプション）を参照してください。これらのパッケージはBioSQLがPostgreSQLデータベースにアクセスするために使用します。
• MySQL Connector / Python（ http://dev.mysql.com/downloads/connector/python/参照）このパッケージはBioSQLがMySQLデータベースにアクセスするために使用され、Python 2および3とPyPyでもサポートされています。
• MySQLdb、 http: //sourceforge.net/projects/mysql-python（省略可能）これはBioSQLがMySQLデータベースにアクセスするために使用した古い代替パッケージですが、Python 3やPyPyでは利用できません。

これらのライブラリの中には、PyPyやJythonでは利用できないものもありますが、Python 3でもそのすべてが利用できるわけではありません。

さらに、スタンドアロンのNCBI BLAST、EMBOSS、ClustalWなど、インストールしたいと思うたくさんの便利なサードパーティツールがあります。

ソースからのインストール

PyPI上で利用可能なプリコンパイルされたバイナリホイールを使用することをお勧めします。

pip install biopython

ただし、Biopythonを自分でコンパイルする必要がある場合は、コンパイル時に次のものが必要です – Jythonを使用している場合を除きます（サポートは非​​推奨です）。

• python.hような開発ヘッダーファイルを含むPythonは、Linuxではデフォルトでインストールされないことがよくあります（ python-devやpython-devel 、 python pacakgeというパッケージを探してインストールしようとしています）。

• Linux上のGCC、Windows上のMSVCなど、お使いのPython用の適切なCコンパイラ。 Mac OS Xの場合、または現在brandedされているmacOSの場合は、Appleのコマンドラインツールを使用します。これは、terminalコマンドでインストールできます。

  xcode-select --install
  

  これにより、AppleのXcode開発スイートをインストールすることができますが、これは必要ではなく、多くのディスク容量を必要とします。

• NumPy、 http： Bio.Clusterを参照 – このパッケージは、 Bio.Cluster 、 Bio.PDBおよび他のいくつかのモジュールで使用されています。 NumPy C APIを使用しています。つまり、BiopythonのCコードをコンパイルする前にインストールする必要があります。

その後、ソースコードをダウンロードしたり解凍したり、gitを使って取得したりしてください。 次に、ディレクトリをBiopythonソースコードフォルダに変更して実行します。

python setup.py build
python setup.py test
sudo python setup.py install

python3 、 pypy 、 jythonなど、特定のバージョンのpythonをpython3てください。

追加の設定が必要な場合（例えば、インストールディレクトリの接頭辞を変更する場合）は、 python setup.pyと入力するか、次のマニュアルを参照してください：

• HTML – http://biopython.org/DIST/docs/install/Installation.html
• PDF – http://biopython.org/DIST/docs/install/Installation.pdf

テスト

Biopythonには、すべてが正しく実行されているかどうかを確認する一連の回帰テストが含まれています。 テストを実行するには、biopythonのソースコードディレクトリに移動し、次のように入力します。

python setup.py build
python setup.py test

スキップされたテストの警告メッセージが表示された場合、パニックに陥らないでください：

test_DocSQL ... skipping. Install MySQLdb if you want to use Bio.DocSQL.

これは、パッケージがインストールされていないことを意味します。 あなたが使用しようと計画していないモジュールのテストでこの問題が発生した場合は、これを無視することができます。 そのモジュールを使用したい場合は、必要な依存関係をインストールしてテストを再実行してください。

テストの中にはネットワークの問題で失敗するものがありますが、これはしばしばチャンスやサービスの停止に至りません。 テストを再実行しても問題が解決しない場合は、オフラインテストのみを実行することができます。

Biopythonチュートリアル＆クックブックには、より多くのテスト情報があります。

実験コード

Biopython 1.61には新しい警告、 Bio.BiopythonExperimentalWarning導入されました。これは、その他の点で安定したBiopythonリリースに含まれている実験コードをマークするために使用されます。 このような「ベータ」レベルのコードは、より広いテストの準備ができていますが、まだ変更される可能性があり、早期採用者がbiopython-devメーリングリスト経由でフィードバックを与えるだけでよいはずです。

このような実験コードは、1つまたは2つのリリースで安定した状態に達すると期待しています。その時点で、下位互換性を維持しようとする通常のポリシーが適用されます。

バグ

堅牢なパッケージを出荷しようとすると、バグが必然的に発生します。 Biopythonのバグに起因する問題がある場合は、すでに識別されている可能性があります。 最新のリリースを使用していない場合は、最新のリリースに更新して再試行してください。 問題が解決しない場合は、バグデータベースとメーリングリストで既に報告されているかどうかを確認してください。 私たちは知らない問題を解決することはできません;）

• 古い問題のトラッカー： https : //redmine.open-bio.org/projects/biopython
• 現在の課題トラッカー： https : //github.com/biopython/biopython/issues

問題がパーサ内にあると思われる場合は、データ形式が変更され、解析コードが壊れている可能性があります。 （テキストBLASTとGenBankのフォーマットは特に壊れやすいようです）。したがって、Biopythonの解析コードは、Biopythonリリースを構築するよりも速く更新されることがあります。 関連するファイル（ Bio.SeqIOやBio.Blast ）をgitリポジトリから取得して、最新のパーサを入手することができます。 しかし、githubのコードはリリースされたコードほど徹底的にテストされておらず、新しい依存関係が含まれている可能性があるため、これを行うときは注意が必要です。

最後に、バグレポートをバグデータベースまたはメーリングリストbiopython@biopython.org （購読が必要）に送ることができます。 バグレポートでは、私たちに知らせてください：

1. 使用しているオペレーティングシステムとハードウェア（32ビットまたは64ビット）
2. Pythonバージョン
3. Biopythonのバージョン（またはgit commit / date）
4. 発生したトレースバック（完全なエラーメッセージ）

また理想的には：

1. ブレークするコードの例
2. 問題の原因となるデータファイル

貢献する、バグレポート

Biopythonは、さまざまな種類の背景を持つ世界中のボランティアによって運営されています。 私たちは常に、コード開発、Webサイト管理、文書作成、技術管理、その他何が起きているかに関心を持つ人々を探しています。

貢献したい場合は、ウェブサイトhttp://biopython.orgをご覧になり、メーリングリストに参加してください： http : //biopython.org/wiki/Mailing_lists

流通構造

• README.rst – このファイル。
• NEWS.rst – リリースノートとニュース。
• LICENSE.rst – コードでできること。
• CONTRIB.rst – CONTRIB.rstを助けてくれた人のリスト（不完全なリスト）。
• DEPRECATED.rst – 削除された、または使用を推奨されなくなったモジュール、およびそれらのモジュールを使用するコードを更新する方法に関する情報がBiopythonに含まれています。
• MANIFEST.in – リリースに含めるファイルを設定します。
• setup.py – インストールファイル。
• Bio/ – メインコードの基本コード。
• BioSQL/ – BioSQLとBioSQLデータベースを使用するためのコード。
• Doc/ – ドキュメンテーション。
• Scripts/その他の、おそらく有用なスタンドアロンのスクリプト。
• Tests/ – サンプルデータファイルを含む回帰テストコード。