Biopython
1.0.0
Das Biopython-Projekt ist eine internationale Vereinigung von Entwicklern frei verfügbarer Python-Tools für die computergestützte Molekularbiologie.
Diese README-Datei ist in erster Linie für Personen gedacht, die an der Arbeit mit dem Biopython-Quellcode interessiert sind, entweder einer der Versionen von der Website http://biopython.org oder aus unserem Repository auf GitHub https://github.com/biopython/biopython
Unsere benutzerzentrierte Dokumentation, das Biopython Tutorial and Cookbook, und die API-Dokumentation werden aus unserem Repository mit Sphinx generiert.
Die NEWS-Datei fasst die Änderungen in jeder Version von Biopython zusammen, zusammen mit der DEPRECATED-Datei, die auf API-Fehler hinweist.
Das Biopython-Paket ist eine Open-Source-Software, die zu großzügigen Konditionen zur Verfügung gestellt wird. Weitere Einzelheiten finden Sie in der LIZENZ-Datei.
Wenn Sie Biopython in einer Arbeit verwenden, die zu einer wissenschaftlichen Veröffentlichung beiträgt, bitten wir Sie, unseren Anwendungshinweis (unten) oder eine der modulspezifischen Veröffentlichungen (auf unserer Website aufgeführt) zu zitieren:
Cock, PJA et al. Biopython: frei verfügbare Python-Tools für computergestützte Molekularbiologie und Bioinformatik. Bioinformatik 1. Juni 2009; 25(11) 1422-3 https://doi.org/10.1093/bioinformatics/btp163 pmid:19304878
Python enthält das Paketverwaltungssystem „pip“, mit dem Sie Biopython (und ggf. seine Abhängigkeit NumPy) mit nur einem Terminalbefehl installieren, aktualisieren oder deinstallieren können:
pip Biopython installieren pip install --upgrade biopython pip Biopython deinstallieren
Seit Biopython 1.70 stellen wir vorkompilierte Binärrad-Pakete auf PyPI für Linux, macOS und Windows bereit. Das bedeutet, dass die Pip-Installation schnell erfolgen sollte und keinen Compiler erfordert.
Als Entwickler oder potenzieller Mitwirkender möchten Sie Biopython möglicherweise selbst herunterladen, erstellen und installieren. Dies wird im Folgenden beschrieben.
Wir empfehlen derzeit die Verwendung von Python 3.11 von http://www.python.org
Biopython wird derzeit auf den folgenden Python-Implementierungen unterstützt und getestet:
Biopython erfordert NumPy (siehe http://www.numpy.org), das automatisch installiert wird, wenn Sie Biopython mit pip installieren (siehe unten, um Biopython selbst zu kompilieren).
Abhängig davon, welche Teile von Biopython Sie verwenden möchten, gibt es eine Reihe weiterer optionaler Python-Abhängigkeiten, die bei Bedarf später installiert werden können:
Bio.Graphics verwendet. Wenn Sie diese Funktionalität also nicht benötigen, müssen Sie dieses Paket nicht installieren.Bio.Phylo verwendet dieses Paket, um phylogenetische Bäume zu zeichnen.Bio.Phylo verwendet.Bio.Phylo verwendet.BioSQL verwendet, um auf eine PostgreSQL-Datenbank zuzugreifen.BioSQL verwendet, um auf eine MySQL-Datenbank zuzugreifen, und wird auch auf PyPy unterstützt.BioSQL verwendet, um auf eine MySQL-Datenbank zuzugreifen. Es wird von PyPy unterstützt.Darüber hinaus gibt es eine Reihe nützlicher Tools von Drittanbietern, die Sie möglicherweise installieren möchten, z. B. die eigenständigen Tools NCBI BLAST, EMBOSS oder ClustalW.
Wir empfehlen die Verwendung der auf PyPI verfügbaren vorkompilierten Binärräder mit:
pip Biopython installieren
Wenn Sie Biopython jedoch selbst kompilieren müssen, ist zur Kompilierungszeit Folgendes erforderlich:
Python einschließlich Entwicklungs-Header-Dateien wie python.h , die unter Linux oft nicht standardmäßig installiert sind (versuchen Sie, ein Paket namens python-dev oder python-devel sowie das python Paket zu suchen und zu installieren).
Passender C-Compiler für Ihre Python-Version, zum Beispiel GCC unter Linux, MSVC unter Windows. Verwenden Sie für Mac OS
xcode-select --install
Dies bietet die Möglichkeit, die XCode-Entwicklungssuite von Apple zu installieren. Dies ist jedoch nicht erforderlich und nimmt viel Speicherplatz in Anspruch.
Laden Sie dann entweder unseren Quellcode herunter und dekomprimieren Sie ihn oder rufen Sie ihn mit Git ab. Wechseln Sie nun in das Verzeichnis mit dem Biopython-Quellcode und führen Sie Folgendes aus:
pip install -e . Python setup.py-Test sudo python setup.py installieren
Ersetzen Sie python bei Bedarf durch Ihre spezifische Version, zum Beispiel python3 oder pypy3 .
Um Tests auszuschließen, die eine Internetverbindung erfordern (und möglicherweise lange dauern), verwenden Sie die Option --offline :
Python setup.py test --offline
Wenn Sie zusätzliche Konfigurationen vornehmen müssen, z. B. das Installationsverzeichnis-Präfix ändern, geben Sie bitte python setup.py ein.
Biopython enthält eine Reihe von Regressionstests, um zu überprüfen, ob alles korrekt läuft. Um die Tests auszuführen, gehen Sie zum Biopython-Quellcodeverzeichnis und geben Sie Folgendes ein:
pip install -e . Python setup.py-Test
Wenn Sie die Online-Tests überspringen möchten (was bei wiederholten Tests empfohlen wird), verwenden Sie:
Python setup.py test --offline
Keine Panik, wenn Sie Meldungen sehen, die vor übersprungenen Tests warnen:
test_DocSQL ... überspringen. Installieren Sie MySQLdb, wenn Sie Bio.DocSQL verwenden möchten.
Dies bedeutet höchstwahrscheinlich, dass ein Paket nicht installiert ist. Sie können dies ignorieren, wenn es in den Tests für ein Modul auftritt, das Sie nicht verwenden wollten. Wenn Sie dieses Modul verwenden möchten, installieren Sie bitte die erforderliche Abhängigkeit und führen Sie die Tests erneut aus.
Einige Tests können aufgrund von Netzwerkproblemen fehlschlagen. Dies ist häufig auf Zufall oder einen Dienstausfall zurückzuführen. Wenn das Problem beim erneuten Ausführen der Tests nicht behoben wird, können Sie die Option --offline verwenden.
Weitere Testinformationen finden Sie im Biopython Tutorial & Cookbook.
Biopython 1.61 führte eine neue Warnung ein, Bio.BiopythonExperimentalWarning , die verwendet wird, um jeglichen experimentellen Code zu kennzeichnen, der in den ansonsten stabilen Biopython-Versionen enthalten ist. Ein solcher Code auf „Beta“-Ebene ist für umfassendere Tests bereit, wird sich aber wahrscheinlich noch ändern und sollte nur von Erstanwendern ausprobiert werden, um über die Mailingliste „biopython-dev“ Feedback zu geben.
Wir gehen davon aus, dass dieser experimentelle Code innerhalb von ein oder zwei Releases einen stabilen Status erreicht. Ab diesem Zeitpunkt gelten unsere normalen Richtlinien zur Wahrung der Abwärtskompatibilität.
Während wir versuchen, ein robustes Paket zu versenden, tauchen unweigerlich Fehler auf. Wenn Sie Probleme haben, die durch einen Fehler in Biopython verursacht werden könnten, ist es möglich, dass dieser bereits identifiziert wurde. Aktualisieren Sie auf die neueste Version, wenn Sie diese noch nicht verwenden, und versuchen Sie es erneut. Wenn das Problem weiterhin besteht, durchsuchen Sie bitte unsere Fehlerdatenbank und unsere Mailinglisten, um zu sehen, ob es bereits gemeldet (und hoffentlich behoben) wurde. Wenn nicht, melden Sie den Fehler bitte. Wir können keine Probleme beheben, von denen wir nichts wissen ;)
Issue-Tracker: https://github.com/biopython/biopython/issues
Wenn Sie vermuten, dass das Problem bei einem Parser liegt, hat sich wahrscheinlich das Datenformat geändert und der Parsercode beschädigt. (Die Textformate BLAST und GenBank scheinen besonders fragil zu sein.) Daher wird der Parsing-Code in Biopython manchmal schneller aktualisiert, als wir Biopython-Releases erstellen können. Sie können den neuesten Parser erhalten, indem Sie die relevanten Dateien (z. B. die in Bio.SeqIO oder Bio.Blast ) aus unserem Git-Repository abrufen. Seien Sie dabei jedoch vorsichtig, da der Code in Github nicht so gut getestet ist wie der veröffentlichte Code und möglicherweise neue Abhängigkeiten enthält.
Bitte teilen Sie uns in jedem Fehlerbericht Folgendes mit:
Und im Idealfall auch:
Biopython wird von Freiwilligen aus der ganzen Welt mit den unterschiedlichsten Hintergründen betrieben. Wir sind immer auf der Suche nach Leuten, die Interesse haben, bei der Codeentwicklung, der Website-Verwaltung, dem Verfassen von Dokumentationen, der technischen Verwaltung und allem, was sonst noch anfällt, mitzuhelfen.
Wenn Sie einen Beitrag leisten möchten, lesen Sie bitte zuerst CONTRIBUTING.rst hier, besuchen Sie unsere Website http://biopython.org und treten Sie unserer Mailingliste bei: http://biopython.org/wiki/Mailing_lists
README.rst – Diese Datei.NEWS.rst – Versionshinweise und Neuigkeiten.LICENSE.rst – Was Sie mit dem Code machen können.CONTRIB.rst – Eine (unvollständige) Liste von Personen, die Biopython auf die eine oder andere Weise geholfen haben.CONTRIBUTING.rst – Eine Übersicht darüber, wie man zu Biopython beiträgt.DEPRECATED.rst – Enthält Informationen zu Modulen in Biopython, die entfernt wurden oder nicht mehr zur Verwendung empfohlen werden, und wie Code aktualisiert wird, der diese Module verwendet.MANIFEST.in – Konfiguriert, welche Dateien in Releases einbezogen werden sollen.setup.py – Installationsdatei.Bio/ – Der Hauptcode-Basiscode.BioSQL/ – Code für die Verwendung von Biopython mit BioSQL-Datenbanken.Doc/ – Dokumentation.Scripts/ – Verschiedene, möglicherweise nützliche, eigenständige Skripte.Tests/ – Regressionstestcode einschließlich Beispieldatendateien.
