biopython
1.0.0
Le projet Biopython est une association internationale de développeurs d'outils Python disponibles gratuitement pour la biologie moléculaire computationnelle.
Ce fichier README est principalement destiné aux personnes intéressées à travailler avec le code source de Biopython, soit l'une des versions du site http://biopython.org, soit de notre référentiel sur GitHub https://github.com/biopython/biopython
Notre documentation centrée sur l'utilisateur, le didacticiel et le livre de recettes Biopython, ainsi que la documentation de l'API, sont générées à partir de notre référentiel à l'aide de Sphinx.
Le fichier NEWS résume les modifications apportées à chaque version de Biopython, aux côtés du fichier DEPRECATED qui note les ruptures d'API.
Le package Biopython est un logiciel open source mis à disposition à des conditions généreuses. Veuillez consulter le fichier LICENSE pour plus de détails.
Si vous utilisez Biopython dans le cadre de travaux contribuant à une publication scientifique, nous vous demandons de citer notre note d'application (ci-dessous) ou l'une des publications spécifiques au module (répertoriées sur notre site Internet) :
Cock, PJA et coll. Biopython : outils Python disponibles gratuitement pour la biologie moléculaire computationnelle et la bioinformatique. Bioinformatique 1er juin 2009 ; 25(11) 1422-3 https://doi.org/10.1093/bioinformatics/btp163 pmid:19304878
Python inclut le système de gestion de packages "pip" qui devrait vous permettre d'installer Biopython (et sa dépendance NumPy si nécessaire), de mettre à niveau ou de désinstaller avec une seule commande de terminal :
pip installer biopython pip install --upgrade biopython pip désinstaller biopython
Depuis Biopython 1.70, nous fournissons des packages de roues binaires précompilés sur PyPI pour Linux, macOS et Windows. Cela signifie que l'installation de pip doit être rapide et ne nécessiter aucun compilateur.
En tant que développeur ou contributeur potentiel, vous souhaiterez peut-être télécharger, créer et installer Biopython vous-même. Ceci est décrit ci-dessous.
Nous recommandons actuellement d'utiliser Python 3.11 à partir de http://www.python.org
Biopython est actuellement pris en charge et testé sur les implémentations Python suivantes :
Biopython nécessite NumPy (voir http://www.numpy.org) qui sera installé automatiquement si vous installez Biopython avec pip (voir ci-dessous pour compiler Biopython vous-même).
Selon les parties de Biopython que vous envisagez d'utiliser, il existe un certain nombre d'autres dépendances Python facultatives, qui peuvent être installées ultérieurement si nécessaire :
Bio.Graphics , donc si vous n'avez pas besoin de cette fonctionnalité, vous n'aurez pas besoin d'installer ce package.Bio.Phylo utilise ce package pour tracer des arbres phylogénétiques.Bio.Phylo .Bio.Phylo .BioSQL pour accéder à une base de données PostgreSQL.BioSQL pour accéder à une base de données MySQL et est également pris en charge sur PyPy.BioSQL pour accéder à une base de données MySQL. Il est pris en charge par PyPy.En outre, il existe un certain nombre d'outils tiers utiles que vous souhaiterez peut-être installer, tels que NCBI BLAST, EMBOSS ou ClustalW autonomes.
Nous vous recommandons d'utiliser les roues binaires précompilées disponibles sur PyPI en utilisant :
pip installer biopython
Cependant, si vous devez compiler Biopython vous-même, les éléments suivants sont requis au moment de la compilation :
Python, y compris les fichiers d'en-tête de développement comme python.h , qui sous Linux ne sont souvent pas installés par défaut (en essayant de rechercher et d'installer un package nommé python-dev ou python-devel ainsi que le package python ).
Compilateur C approprié pour votre version de Python, par exemple GCC sous Linux, MSVC sous Windows. Pour Mac OS X, ou comme son nom actuel, macOS, utilisez les outils de ligne de commande d'Apple, qui peuvent être installés avec la commande terminal :
xcode-select --install
Cela proposera d'installer la suite de développement XCode d'Apple - vous pouvez, mais ce n'est pas nécessaire et prend beaucoup d'espace disque.
Ensuite, téléchargez et décompressez notre code source, ou récupérez-le en utilisant git. Changez maintenant de répertoire pour le dossier du code source Biopython et exécutez :
pip install -e . test python setup.py installation sudo python setup.py
Remplacez python par votre version spécifique si nécessaire, par exemple python3 ou pypy3 .
Pour exclure les tests qui nécessitent une connexion Internet (et qui peuvent prendre beaucoup de temps), utilisez l'option --offline :
test python setup.py --hors ligne
Si vous devez effectuer une configuration supplémentaire, par exemple en modifiant le préfixe du répertoire d'installation, veuillez taper python setup.py .
Biopython comprend une suite de tests de régression pour vérifier si tout fonctionne correctement. Pour exécuter les tests, allez dans le répertoire du code source de biopython et tapez :
pip install -e . test python setup.py
Si vous souhaitez ignorer les tests en ligne (ce qui est recommandé lors de tests répétés), utilisez :
test python setup.py --hors ligne
Ne paniquez pas si vous voyez des messages avertissant de tests ignorés :
test_DocSQL ... sauter. Installez MySQLdb si vous souhaitez utiliser Bio.DocSQL.
Cela signifie très probablement qu'un package n'est pas installé. Vous pouvez l'ignorer si cela se produit lors des tests d'un module que vous n'aviez pas prévu d'utiliser. Si vous souhaitez utiliser ce module, veuillez installer la dépendance requise et réexécuter les tests.
Certains tests peuvent échouer en raison de problèmes de réseau, cela est souvent dû au hasard ou à une panne de service. Si le problème ne disparaît pas en réexécutant les tests, vous pouvez utiliser l'option --offline .
Vous trouverez plus d'informations sur les tests dans le didacticiel et le livre de recettes Biopython.
Biopython 1.61 a introduit un nouvel avertissement, Bio.BiopythonExperimentalWarning , qui est utilisé pour marquer tout code expérimental inclus dans les versions autrement stables de Biopython. Un tel code de niveau « bêta » est prêt pour des tests plus larges, mais il est encore susceptible de changer, et ne devrait être essayé que par les premiers utilisateurs afin de donner leur avis via la liste de diffusion biopython-dev.
Nous nous attendons à ce qu'un tel code expérimental atteigne un statut stable dans une ou deux versions, auquel cas nos politiques habituelles visant à préserver la compatibilité ascendante s'appliqueraient.
Alors que nous essayons de livrer un package robuste, des bugs apparaissent inévitablement. Si vous rencontrez des problèmes qui pourraient être causés par un bug dans Biopython, il est possible que celui-ci ait déjà été identifié. Mettez à jour vers la dernière version si vous ne l'utilisez pas déjà, puis réessayez. Si le problème persiste, veuillez effectuer une recherche dans notre base de données de bogues et dans nos listes de diffusion pour voir s'il a déjà été signalé (et, espérons-le, corrigé), et sinon, signalez le bogue. Nous ne pouvons pas résoudre les problèmes dont nous ne connaissons pas ;)
Suivi des problèmes : https://github.com/biopython/biopython/issues
Si vous pensez que le problème réside dans un analyseur, il est probable que le format des données ait changé et cassé le code d'analyse. (Les formats texte BLAST et GenBank semblent particulièrement fragiles.) Ainsi, le code d'analyse dans Biopython est parfois mis à jour plus rapidement que nous ne pouvons créer les versions de Biopython. Vous pouvez obtenir l'analyseur le plus récent en extrayant les fichiers pertinents (par exemple ceux de Bio.SeqIO ou Bio.Blast ) de notre référentiel git. Cependant, soyez prudent lorsque vous effectuez cette opération, car le code de github n'est pas aussi bien testé que le code publié et peut contenir de nouvelles dépendances.
Dans tout rapport de bug, veuillez nous indiquer :
Et aussi idéalement :
Biopython est géré par des bénévoles du monde entier, issus de nombreux horizons. Nous sommes toujours à la recherche de personnes intéressées à aider au développement de code, à la gestion de sites Web, à la rédaction de documentation, à l'administration technique et à tout ce qui se présente.
Si vous souhaitez contribuer, veuillez d'abord lire CONTRIBUTING.rst ici, visitez notre site Web http://biopython.org et rejoignez notre liste de diffusion : http://biopython.org/wiki/Mailing_lists
README.rst -- Ce fichier.NEWS.rst -- Notes de version et actualités.LICENSE.rst -- Ce que vous pouvez faire avec le code.CONTRIB.rst -- Une liste (incomplète) de personnes qui ont aidé Biopython d'une manière ou d'une autre.CONTRIBUTING.rst -- Un aperçu de la façon de contribuer à Biopython.DEPRECATED.rst -- Contient des informations sur les modules de Biopython dont l'utilisation a été supprimée ou dont l'utilisation n'est plus recommandée, ainsi que sur la façon de mettre à jour le code qui utilise ces modules.MANIFEST.in -- Configure les fichiers à inclure dans les versions.setup.py -- Fichier d'installation.Bio/ -- Le code de base du code principal.BioSQL/ -- Code pour utiliser Biopython avec les bases de données BioSQL.Doc/ --Documentation.Scripts/ -- Scripts autonomes divers, éventuellement utiles.Tests/ -- Code de test de régression comprenant des exemples de fichiers de données.
