Metadata-Version: 2.1
Name: ribopy
Version: 0.0.1
Summary: Tools for creating and reading Ribo files.
Home-page: UNKNOWN
Author: Hakan Ozadam
License: MIT
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Description-Content-Type: text/markdown
Requires-Dist: numpy (>=1.16.1)
Requires-Dist: pandas (>=0.24.1)
Requires-Dist: click (==7.0)
Requires-Dist: h5py (>=2.9.0)
Requires-Dist: matplotlib (>=3.0.2)
Requires-Dist: multiprocess (>=0.70.7)
Requires-Dist: pysam (>=0.15.0)
Requires-Dist: pyyaml (>=5.1)

[![Documentation Status](https://readthedocs.org/projects/ribopy/badge/?version=latest)](https://ribopy.readthedocs.io/en/latest/?badge=latest)
[![Build Status](https://travis-ci.com/ribosomeprofiling/ribopy.svg?branch=master)](https://travis-ci.com/ribosomeprofiling/ribopy)
[![PyPI version](https://badge.fury.io/py/ribopy.svg)](https://badge.fury.io/py/ribopy)
[![DOI](https://zenodo.org/badge/203284628.svg)](https://zenodo.org/badge/latestdoi/203284628)


# RiboPy

 RiboPy is a set of tools to create, read and visualize .ribo files. It provides a Command Line Interface and Application Programming Interface to .ribo files.

## Installation

It is highly recommended to create and use a separate environment
using conda before installing RiboPy.

`pip install ribopy`

To install the latest version, use the code in Github

`pip install git+https://github.com/ribosomeprofiling/ribopy.git`

Although pip resolves dependencies and installs required packages automatically,
it is highly recommended that you install the dependencies using conda prior to issuing the pip installation command.

`conda env create -f environment.yml`

After the above command you can install RiboPy via pip, as shown above.


## Documentation

RiboPy documentation, for both command-line interface (CLI) and application programming interface (API), is available on [Read the Docs](https://ribopy.readthedocs.io/en/latest/). Also, specification of [ribo file format](https://ribopy.readthedocs.io/en/latest/ribo_file_format.html) is included in this documentation.

## [Release Notes](https://github.com/ribosomeprofiling/ribopy/blob/master/CHANGES.md)


