A plugin to estimate chromosome sizes from karyotype images.
Project description
napari-kics
A plugin to estimate chromosome sizes from karyotype images.
This napari plugin was generated with Cookiecutter using with @napari's cookiecutter-napari-plugin template.
Table of Contents
- Install
- Usage
- Example
- Citation
- Maintainer
- Contributing
- License
Install
You can install napari-kics
via pip:
pip install napari-kics
This will install all required dependencies as well. We recommend installing it in a virtual environment, e.g. using conda:
conda create -n kics python
conda activate kics
pip install napari-kics
We recommend using mamba as a faster alternative to conda.
Usage
- Launch Napari via command line (
napari
). - Activate the plugin via menu
Plugins -> napari-kics: Karyotype Widget
. - Select file via
File -> Open File
. - Follow instructions in the panel on the right.
You may use the interactive analysis plots directly via command line:
karyotype-analysis-plots
Example
- Launch Napari via command line (
napari
). - Activate the plugin via menu
Plugins -> napari-kics: Karyotype Widget
. - Select file via
File -> Open Sample -> napari-kics: sample
. - Follow instructions in the panel on the right.
Try out the interactive analysis plots directly via command line:
karyotype-analysis-plots --example
Citation
Arne Ludwig, Alexandr Dibrov, Gene Myers, Martin Pippel. Estimating chromosome sizes from karyotype images enables validation of de novo assemblies. To be published.
License
Distributed under the terms of the BSD-3 license, "napari-kics" is free and open source software
Issues
If you encounter any problems, please file an issue along with a detailed description.
Contributing
Contributions are very welcome. Please file a pull request with your contribution.
You can setup a local development environment for napari-kics
via pip:
git clone https://github.com/mpicbg-csbd/napari-kics.git
cd napari-kics
pip install -e .
Overview
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for napari_kics-0.0.3rc6-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4b21e2e82b1277118a59f0b42c6f5c8ef5467c3564f55f46198cf51a56caaf81 |
|
MD5 | c7abdb30d0741db28f1e676b406da997 |
|
BLAKE2b-256 | 536c99b787e89861e0d49f340394cbd1847f7a41cda945ad359764726f3d9e91 |