Napari est une visionneuse d'images rapide, interactive et multidimensionnelle pour Python. Il est conçu pour parcourir, annoter et analyser de grandes images multidimensionnelles. Il est construit sur Qt (pour l'interface graphique), Vispy (pour un rendu performant basé sur GPU) et la pile scientifique Python (numpy, scipy).
Nous développons Napari à l'air libre ! Mais le projet est en phase alpha , et il y aura probablement encore des changements importants à chaque version. Vous pouvez suivre les progrès de ce référentiel, tester les nouvelles versions au fur et à mesure que nous les publions et contribuer aux idées et au code.
Si vous souhaitez consulter notre documentation, veuillez vous rendre sur napari.org. Si vous souhaitez y contribuer, veuillez vous référer à la section de contribution ci-dessous.
Nous travaillons sur des didacticiels, mais vous pouvez également commencer rapidement en regardant ci-dessous.
Il est recommandé d'installer Napari dans un environnement virtuel, comme ceci :
conda create -y -n napari-env -c conda-forge python=3.9 conda activer napari-env python -m pip install "napari[all]"
Si vous préférez conda à pip, vous pouvez remplacer la dernière ligne par : conda install -c conda-forge napari pyqt
Voir ici pour le guide d'installation complet.
(Les exemples ci-dessous nécessitent l'exécution du package scikit-image
. Nous utilisons simplement des échantillons de données de ce package à des fins de démonstration. Si vous modifiez les exemples pour utiliser votre propre ensemble de données, vous n'aurez peut-être pas besoin d'installer ce package.)
Depuis un shell IPython, vous pouvez ouvrir une visionneuse interactive en appelant
à partir de skimage import dataimport napariviewer = napari.view_image(data.cells3d(), channel_axis=1, ndisplay=3)
Pour utiliser Napari depuis un script, utilisez napari.run()
:
from skimage import dataimport napariviewer = napari.view_image(data.cells3d(), channel_axis=1, ndisplay=3)napari.run() # démarre la "boucle d'événement" et affiche la visionneuse
Consultez les scripts dans notre dossier examples
pour voir certaines des fonctionnalités que nous développons !
Napari prend en charge six principaux types de calques différents, Image
, Labels
, Points
, Vectors
, Shapes
et Surface
, chacun correspondant à un type de données, une visualisation et une interactivité différents. Vous pouvez ajouter plusieurs calques de types différents dans la visionneuse, puis commencer à travailler avec eux en ajustant leurs propriétés.
Tous nos types de couches prennent en charge les données à n dimensions et la visionneuse offre la possibilité de parcourir et de visualiser rapidement des tranches 2D ou 3D des données.
Napari prend également en charge la communication bidirectionnelle entre le visualiseur et le noyau Python, ce qui est particulièrement utile lors du lancement à partir de notebooks Jupyter ou lors de l'utilisation de notre console intégrée. L'utilisation de la console vous permet de charger et d'enregistrer de manière interactive les données de la visionneuse et de contrôler toutes les fonctionnalités de la visionneuse par programme.
Vous pouvez étendre Napari à l'aide de raccourcis personnalisés, de raccourcis clavier et de fonctions de souris.
Pour plus de détails sur l'utilisation napari
consultez nos didacticiels. Ce sont encore des travaux en cours, mais nous les mettrons à jour régulièrement.
Pour plus d'informations sur nos projets pour napari
vous pouvez lire notre déclaration de mission et de valeurs, qui comprend plus de détails sur notre vision du support d'un écosystème de plugins autour de Napari. Vous pouvez voir les détails de la feuille de route du projet ici.
Les contributions sont encouragées ! Veuillez lire notre guide de contribution pour commencer. Étant donné que nous n'en sommes qu'à nos débuts, vous souhaiterez peut-être nous contacter sur nos problèmes GitHub avant de vous lancer.
Si vous souhaitez contribuer ou modifier notre documentation, veuillez vous rendre sur napari/docs.
napari
a un code de conduite qui doit être respecté par tous ceux qui participent à la communauté napari
.
Vous pouvez en savoir plus sur la façon dont le projet napari
est organisé et géré à partir de notre modèle de gouvernance, qui comprend des informations et des moyens de contacter @napari/steering-council et @napari/core-devs.
Si vous trouvez napari
utile, veuillez citer ce référentiel en utilisant son DOI comme suit :
Contributeurs Napari (2019). Napari : une visionneuse d'images multidimensionnelles pour Python. est ce que je:10.5281/zenodo.3555620
Notez que ce DOI sera résolu pour toutes les versions de Napari. Pour citer une version spécifique, veuillez trouver le DOI de cette version sur notre page zenodo. Le DOI de la dernière version se trouve dans le badge en haut de cette page.
Nous sommes un partenaire communautaire sur le forum image.sc et toutes les demandes d'aide et de support doivent être publiées sur le forum avec le tag napari
. Nous sommes impatients d'interagir avec vous là-bas.
Les rapports de bugs doivent être effectués sur nos problèmes GitHub à l'aide du modèle de rapport de bug. Si vous pensez que quelque chose ne fonctionne pas, n'hésitez pas à nous contacter : c'est probablement nous et pas vous !