creisle / rna_sv_simulator

RNA SV Simulator

Simulating transcriptome structural variants

• Free software: GNU General Public License v3
• Documentation: https://rna-sv-simulator.readthedocs.io.

Features

• TODO

Getting started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

• Python3.5+
• Flux Simulator (tested with v1.2.2)

Installing

Checkout the latest release from Github

$ git clone https://github.com/creisle/rna_sv_simulator.git
$ cd rna_sv_simulator

Create a new virtual env

$ python3 -m venv venv/
$ source venv/bin/activate

With the virtual env, install the package with editable permissions

$ pip install -e .[dev]

Deployment

Add additional notes about how to deploy this on a live system

Built With

• CookieCutter - Templating
• PyPackage - Packaging

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We use SemVer for versioning.

Authors

• Cara Reisle - Team lead - GitHub
• Morgan Bye - Voice of experience - morganbye.com

See also the list of contributors who participated in this project.

License

This project is licensed under the MIT License - see the LICENSE file for details

Acknowledgments

• HackSeq18