Skip to main content

Open Source Transcription Initiation Rates

Project description

OSTIR (Open Source Translation Initiation Rates)

Status Bioconda Anaconda Badge

OSTIR is a Python package for predicting the rates at which ribosomes will bind to and initiate translation from different start codons in bacterial mRNAs. It uses the ViennaRNA Package to perform the necessary free energy calculations. The code builds on the last open source version of the RBS calculator.

OSTIR includes several improvements in usability. It supports multi-FASTA input with command line parameters or CSV input that can define parameters on a per-sequence basis. Additionally, OSTIR supports multi-threaded execution, accelerating the analysis of very large sequences.

Please see the OSTIR Wiki for full documentation

Quickstart

Installation

Step by step

install with bioconda

OSTIR is a Python module and associated command line script. We recommend installing OSTIR using Bioconda on Linux or macOS. This will automatically install OSTIR and all of its dependencies, including ViennaRNA and the required Python modules.

From Bioconda (recommended; Linux, macOS):

  • Run conda install -c bioconda ostir

From Pip (for experts; Linux, macOS, Windows):

  • Download and install ViennaRNA, following the instructions here.
  • Run pip install ostir

For information on installing for development see the Wiki Documentation.

Docker

For an express run and assuming there is Docker in your system you may:

docker build . -t ostir:latest
docker run -it ostir

You should see ostir -h output

Note: By default Dockerfile is linked to Dockerfile.miniforge so that miniforge is being used to install conda. If you want any other installer (Miniconda or Anaconda), please rename/link at your best convenience.

Command Line Usage

Print OSTIR help:

ostir -h

Run OSTIR on a sequence provided at the command line and print output to the console:

ostir -i TTCTAGATGAGAATAAGGTTATGGCGAGCTCTGAAGACGTTATCAAAGAGTTCATGCGTTTCAAAGTTCGTATGGAAGGT

Run OSTIR on all sequences provided in a FASTA file and print output to a CSV file:

ostir -i input.fasta -o output.csv

More options and examples are described in the Wiki Documentation.

Python Module Usage

Run OSTIR on a sequence inside of a Python script:

from ostir import run_ostir

seq = "ACUUCUAAUUUAUUCUAUUUAUUCGCGGAUAUGCAUAGGAGUGCUUCGAUGUCAU"
results = run_ostir(seq, name="my_sequence", threads=8)
print(results)

More options and examples are described in the Wiki Documentation.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ostir-1.1.3.tar.gz (165.2 kB view details)

Uploaded Source

Built Distribution

OSTIR-1.1.3-py3-none-any.whl (106.2 kB view details)

Uploaded Python 3

File details

Details for the file ostir-1.1.3.tar.gz.

File metadata

  • Download URL: ostir-1.1.3.tar.gz
  • Upload date:
  • Size: 165.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for ostir-1.1.3.tar.gz
Algorithm Hash digest
SHA256 6fa38a4e867c8d38aab16b59addc07ce2de03ee766ef6018c24c7a78ff163e14
MD5 f908ca01117d2b3822f57f8e36a9553d
BLAKE2b-256 abf76e62f0f43ff828da0f24696bc70b34f9ea2d6b70490d2e2a4fadaf168213

See more details on using hashes here.

Provenance

The following attestation bundles were made for ostir-1.1.3.tar.gz:

Publisher: publish-to-pypi.yml on barricklab/ostir

Attestations:

File details

Details for the file OSTIR-1.1.3-py3-none-any.whl.

File metadata

  • Download URL: OSTIR-1.1.3-py3-none-any.whl
  • Upload date:
  • Size: 106.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for OSTIR-1.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 13f94950a2316ff83f06f0830477e2d4ebd240bc1941453716a5db8055a6ce2f
MD5 357ac1b47337ef3fb9fe92d4853de624
BLAKE2b-256 8b2a225597f7fe6ee1b446cdd6362e8b23c547c28a760e024099fefdaad52728

See more details on using hashes here.

Provenance

The following attestation bundles were made for OSTIR-1.1.3-py3-none-any.whl:

Publisher: publish-to-pypi.yml on barricklab/ostir

Attestations:

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page