Giter Club home page Giter Club logo

chiron's Introduction

Chiron

A basecaller for Oxford Nanopore Technologies' sequencers

Using a deep learning CNN+RNN+CTC structure to establish end-to-end basecalling for the nanopore sequencer. Built with TensorFlow and python 2.7.

If you found Chiron useful, please consider to cite:

Teng, H., et al. (2017). Chiron: Translating nanopore raw signal directly into nucleotide sequence using deep learning. [bioRxiv 179531] (https://www.biorxiv.org/content/early/2017/09/12/179531)


Install

Installing dependencies

Chiron requires the following packages:

  • Tensorflow >= 1.0.1
  • numpy >= 1.13.1
  • h5py >= 2.6

Follow this guide for installing Tensorflow, if possible with GPU support. You can use pip for installing numpy and h5py:

pip install numpy
pip install h5py

Installing Chiron

To install Chiron, first clone the repository to your local machine:

git clone https://github.com/cangermueller/Chiron.git

To install the Chiron package for code development, execute the following command in the Chiron root directory:

cd Chiron
python setup.py develop

In this way, changes to the source code are visible right away.

Testing Chiron

To test the installation and train Chiron on a small dataset, decompress the example data and execute the example script:

cd ./examples
tar xf ./data.tar.gz
cd ./train
./train.sh

Using chiron

Chiron provides a train, call, and export command for training models, base calling, and exporting signal/label files from fast5 files.

chiron {train,call,export} [FLAGS]

You can get more information about the different commands by using the --help flag, e.g. chiron train --help, or reading the official Chiron guide.

Contact

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.