Skip to content

ribosomeprofiling/ribopy

Repository files navigation

Documentation Status Build Status PyPI version DOI

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. Also, specification of ribo file format is included in this documentation.

Citing

RiboFlow, RiboR and RiboPy: an ecosystem for analyzing ribosome profiling data at read length resolution, H. Ozadam, M. Geng, C. Cenik Bioinformatics 36 (9), 2929-2931

@article{ozadam2020riboflow,
  title={RiboFlow, RiboR and RiboPy: an ecosystem for analyzing ribosome profiling data at read length resolution},
  author={Ozadam, Hakan and Geng, Michael and Cenik, Can},
  journal={Bioinformatics},
  volume={36},
  number={9},
  pages={2929--2931},
  year={2020},
  publisher={Oxford University Press}
}