Skip to main content

pinetree

pinetree

Build Status Documentation Status

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.

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

Metadata

Release files for pinetree 0.5.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for pinetree 0.5.0
File Size Uploaded Provenance
pinetree-0.5.0.tar.gz 744.8 kB Without provenance Details

Release files / pinetree-0.5.0.tar.gz

Download URL pinetree-0.5.0.tar.gz
Size 744.8 kB
Tags Source
SHA-256 checksum
How to use checksums
5c1c37a15caa9b7e9a8d9507fc7c93f75b0734f8cbded4d7afe1cb2d584029c7
BLAKE2b-256 checksum
How to use checksums
68ef8f9b5e9ad0b64bcaf748323c2f6e927c83cdfa3098830d4797fbe64798b9
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.9.6

Security for pinetree 0.5.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page