Metadata-Version: 2.1
Name: BSBolt
Version: 0.1.1
Summary: Bisulfite Sequencing Processing Platform
Home-page: https://github.com/NuttyLogic/BSBolt
Author: Colin P. Farrell
Author-email: colinpfarrell@gmail.com
License: GPLv3
Project-URL: Documentation, https://bsbolt.readthedocs.io/en/latest/
Description: # BSBolt (BiSulfite Bolt)
        ## A fast and safe read alignment platform for bisulfite sequencing data
        
        [BiSuflite Bolt (BSBolt)](https://github.com/NuttyLogic/BSBolt); a fast and scalable bisulfite sequencing analysis platform. BSBolt is an integrated analysis 
        platform that offers support for bisulfite sequencing read simulation, alignment, methylation calling, data aggregation, 
        and data imputation. BSBolt has been validated to work with a wide array of bisulfite sequencing data, 
        including whole genome bisulfite sequencing (WGBS), reduced representative bisulfite sequencing data (RRBS), 
        and targeted methylation sequencing data.
         
        ## Documentation
        
        BSBolt documentation can be found at [bsbolt.readthedocs.io](https://bsbolt.readthedocs.io).
        
        ### Installation
        
        At installation BSBolt compiles two external dependencies 
        [Bowtie2](http://bowtie-bio.sourceforge.net/bowtie2/manual.shtml)
        and [ART Read Simulation Tools](https://www.niehs.nih.gov/research/resources/software/biostatistics/art/index.cfm) 
        under the terms of the [GPLv3 License](https://www.gnu.org/licenses/gpl-3.0.html). Installation failures are generally 
        due to external C libraries not being installed or not being on path. 
        
        ```shell
        pip3 install BSBolt -v
        ```
        
        1. Python Dependencies
            - [pysam](https://github.com/pysam-developers/pysam) >= 0.15.2
            - [numpy](https://numpy.org/) >=1.16.3
            - [tqdm](https://github.com/tqdm/tqdm) >= 4.31.1
        2. External C Dependencies
            - libgsl
            - zlib      
            - libbz2
            - liblzma
            - libcurl
            - libcrypto  
         
        
Platform: UNKNOWN
Requires: pysam
Requires: numpy
Requires: tqdm
Requires-Python: >=3.6
Description-Content-Type: text/markdown
