pinetree

Name	pinetree JSON
Version	0.4.0 JSON
	download
home_page	https://github.com/clauswilke/pinetree
Summary	stochastic simulation of gene expression with site-specific translation rates
upload_time	2022-12-20 19:29:30
maintainer
docs_url	None
author	Benjamin Jack
requires_python
license	MIT
keywords	gene codon transcription translation biology stochastic
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI
coveralls test coverage	No coveralls.

            ![pinetree](https://github.com/clauswilke/pinetree/blob/master/docs/pinetree-logo.png?raw=true)

# pinetree 
[![Build Status](https://travis-ci.org/clauswilke/pinetree.svg?branch=master)](https://travis-ci.org/clauswilke/pinetree)
[![Documentation Status](https://readthedocs.org/projects/pinetree/badge/?version=latest)](http://pinetree.readthedocs.io/en/latest/?badge=latest)

A flexible gene expression simulator with codon-specific translation rates.

## Requirements

Pinetree requires Python, CMake, and a modern C++ compiler. Python 3 is recommended.

## Installation

To install the latest stable version of pinetree from PyPI, run the following:

```
pip3 install cmake  # CMake must be installed before installing pinetree
pip3 install pinetree 
```

The latest development build may be installed from GitHub as follows:

```
pip3 install cmake   
git clone https://github.com/benjaminjack/pinetree.git
cd pinetree
pip3 install .
```

## Documentation

Full documentation is available [here](http://pinetree.readthedocs.io/).

You may also build the documentation from the source code. Building the documentation requires sphinx.

```
pinetree/setup.py build_sphinx
```

## Reproducing plots from manuscript

This repository contains scripts to reproduce the simulations and plots from the manuscript that describes Pinetree. R and the R packages `cowplot`, `readr`, `dplyr`, and `stringr` are required to generate plots. Run the following to reproduce the plots from the manuscript:

```
python3 ./examples/three_genes.py
python3 ./examples/three_genes_recoded.py
Rscript plots.R
```

To simulate a bacteriophage T7 infection, run the following script.

```
# WARNING: This simulation takes approximately 2-3 hours to complete
python3 ./examples/phage_model.py
```
            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/clauswilke/pinetree",
    "name": "pinetree",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "gene,codon,transcription,translation,biology,stochastic",
    "author": "Benjamin Jack",
    "author_email": "benjamin.r.jack@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/6f/4e/9bcf96b34f67feef37f3afb8a5aafe824d37f2ec18c1eab9794f82264255/pinetree-0.4.0.tar.gz",
    "platform": null,
    "description": "![pinetree](https://github.com/clauswilke/pinetree/blob/master/docs/pinetree-logo.png?raw=true)\n\n# pinetree \n[![Build Status](https://travis-ci.org/clauswilke/pinetree.svg?branch=master)](https://travis-ci.org/clauswilke/pinetree)\n[![Documentation Status](https://readthedocs.org/projects/pinetree/badge/?version=latest)](http://pinetree.readthedocs.io/en/latest/?badge=latest)\n\nA flexible gene expression simulator with codon-specific translation rates.\n\n## Requirements\n\nPinetree requires Python, CMake, and a modern C++ compiler. Python 3 is recommended.\n\n## Installation\n\nTo install the latest stable version of pinetree from PyPI, run the following:\n\n```\npip3 install cmake  # CMake must be installed before installing pinetree\npip3 install pinetree \n```\n\nThe latest development build may be installed from GitHub as follows:\n\n```\npip3 install cmake   \ngit clone https://github.com/benjaminjack/pinetree.git\ncd pinetree\npip3 install .\n```\n\n## Documentation\n\nFull documentation is available [here](http://pinetree.readthedocs.io/).\n\nYou may also build the documentation from the source code. Building the documentation requires sphinx.\n\n```\npinetree/setup.py build_sphinx\n```\n\n## Reproducing plots from manuscript\n\nThis repository contains scripts to reproduce the simulations and plots from the manuscript that describes Pinetree. R and the R packages `cowplot`, `readr`, `dplyr`, and `stringr` are required to generate plots. Run the following to reproduce the plots from the manuscript:\n\n```\npython3 ./examples/three_genes.py\npython3 ./examples/three_genes_recoded.py\nRscript plots.R\n```\n\nTo simulate a bacteriophage T7 infection, run the following script.\n\n```\n# WARNING: This simulation takes approximately 2-3 hours to complete\npython3 ./examples/phage_model.py\n```",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "stochastic simulation of gene expression with site-specific translation rates",
    "version": "0.4.0",
    "split_keywords": [
        "gene",
        "codon",
        "transcription",
        "translation",
        "biology",
        "stochastic"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "a6dda8521d649025256d125b813267cd",
                "sha256": "5406c8464be5a6a93fdbec4cca8fd12ac5967efb40fe7bef52ec56b1668af6a4"
            },
            "downloads": -1,
            "filename": "pinetree-0.4.0.tar.gz",
            "has_sig": false,
            "md5_digest": "a6dda8521d649025256d125b813267cd",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 548795,
            "upload_time": "2022-12-20T19:29:30",
            "upload_time_iso_8601": "2022-12-20T19:29:30.704119Z",
            "url": "https://files.pythonhosted.org/packages/6f/4e/9bcf96b34f67feef37f3afb8a5aafe824d37f2ec18c1eab9794f82264255/pinetree-0.4.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2022-12-20 19:29:30",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "github_user": "clauswilke",
    "github_project": "pinetree",
    "travis_ci": true,
    "coveralls": false,
    "github_actions": true,
    "lcname": "pinetree"
}