https://github.com/barricklab/ostir
Software for predicting translation initiation rates in bacteria
https://github.com/barricklab/ostir
bioengineering rna-structure synthetic-biology
Last synced: 3 months ago
JSON representation
Software for predicting translation initiation rates in bacteria
- Host: GitHub
- URL: https://github.com/barricklab/ostir
- Owner: barricklab
- License: gpl-3.0
- Created: 2019-05-21T19:54:43.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2025-07-30T19:23:03.000Z (11 months ago)
- Last Synced: 2026-03-27T15:44:15.800Z (3 months ago)
- Topics: bioengineering, rna-structure, synthetic-biology
- Language: Python
- Homepage:
- Size: 6.85 MB
- Stars: 33
- Watchers: 3
- Forks: 9
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Citation: CITATION.cff
- Zenodo: .zenodo.json
Awesome Lists containing this project
README
# OSTIR (Open Source Translation Initiation Rates)
[](https://github.com/barricklab/ostir/actions/workflows/package_and_test.yml) [](https://joss.theoj.org/papers/43d02b32408a161e608b886f63e753c1) [](https://anaconda.org/bioconda/ostir)
`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](https://github.com/hsalis/Ribosome-Binding-Site-Calculator-v1.0).
`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](https://github.com/barricklab/ostir/wiki)
# Quickstart
## Installation
### Step by step
[](http://bioconda.github.io/recipes/ostir/README.html)
`OSTIR` is a Python module and associated command line script. We recommend installing `OSTIR` using [Bioconda](https://bioconda.github.io/) on Linux or macOS. This will automatically install `OSTIR` and all of its dependencies, including [ViennaRNA](https://www.tbi.univie.ac.at/RNA/) 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](https://www.tbi.univie.ac.at/RNA/).
- Run `pip install ostir`
For information on installing for development see the [Wiki Documentation](https://github.com/barricklab/ostir/wiki/Installation).
### 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](https://github.com/barricklab/ostir/wiki/Command-Line-Usage).
## Python Module Usage
Run OSTIR on a sequence inside of a Python script:
```python3
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](https://github.com/barricklab/ostir/wiki/Python-Module-Usage).
[Docker]: https://get.docker.com/