Skip to main content

RNAMoIP

Setup

RNAMoIP can be installed via Pypi with the following command:

pip install rnamoip

You will also need ViennaRNA installed locally:

wget https://www.tbi.univie.ac.at/RNA/download/sourcecode/2_6_x/ViennaRNA-2.6.4.tar.gz
tar -zxvf ViennaRNA-2.6.4.tar.gz

cd ViennaRNA-2.6.4
./configure
make
sudo make install

Python Environment (Optional)

Use your favorite virtual environment for Python. The Python venv module is recommended if you don't have any.

To create a Python version with venv:

python3 -m venv rnamoip-env

Afterward, you can use that environment with the following command:

source rnamoip-env/bin/activate

Python dependencies

To install the Python dependencies, run the following:

pip install -r requirements.txt

The Python bindings are already provided in the requirements file. Please note that RNAMoIP was built using ViennaRNA v2.6.4. For more information, check for ViennaRNA Documentation.

IP Model Solver

Multiple solvers are supported to solve the RNAMoIP equations.

Cp-SAT is a free, open-source IP solver from the OR-tools Package, made by Google. For more information, visit their GitHub here.

CBC

CBC (Coin-or branch and cut) is a free, open-source IP solver available here. It can be useful as an alternative to Gurobi, although considerably slower. It is automatically provided by the MIP python library for 64-bit Intel architecture. For more details, like manual installation, please refer to the MIP doc.

Gurobi (Need License)

To install, follow the directives here. Note that a free academic license can be used for a renewable two-month period.

How to execute

To execute RNAMoIP, you can run the main.py with the following command:

cd src
python -m rnamoip.main --sequence "AAGGUUCC" --structure "........"

You can also provide a more detailed configuration file. By default, it will use the base configuration located in src/data/configuration.json. You can also run the prediction through the Prediction Python class:

# From agrs
from rnamoip.predicter import Predicter

Predicter(
  rna_sequence='AAGGUUCC',
  secondary_structure='........',
  alpha=0.1,
).iterate()

# With a config file path or dict
Predicter(configuration_file='my/path/to/configuration.json').iterate()

For more use cases, with configuration details, please see the Usage Documentation.

Motif Databases

RNAMoIP supports two types of motif databases:

  • (default) The RIN database, parser of type rin. RNAMoIP already provides a rins database of all local rins.
  • The original RNAMoIP database, parser of type desc, is available here.

You need to specify the path of the motif database accordingly in the motifs_path property, and the motif type with the parser property. For more info, see the Usage Documentation.

Scripts

Useful scripts related to the project can be found under the scripts folder.

Benchmark

To run a batch of multiple prediction RNAMoIP, with all chains that what used in the benchmark. Note that a dependency (forgi) doesn't support Python 3.11 yet on OSX, so you might need Python 3.10.

pip install -r requirements-analysis.txt
python -m rnamoip.multi_batch_analysis --chains_source="../data/chain/chains.json"

Metadata

Release files for rnamoip 1.1.2

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

Source distribution (sdist)

Source distribution for rnamoip 1.1.2
File Size Uploaded Provenance Actions
rnamoip-1.1.2.tar.gz 41.2 MB Without provenance Details for rnamoip-1.1.2.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for rnamoip 1.1.2
File Interpreter ABI Platform Actions
rnamoip-1.1.2-py3-none-any.whl Python 3 none any Details for rnamoip-1.1.2-py3-none-any.whl

Total release size: 42.5 MB

Release files / rnamoip-1.1.2.tar.gz

Download URL rnamoip-1.1.2.tar.gz
Size 41.2 MB
Tags Source
SHA-256 checksum
How to use checksums
f6d80f08e7ffdcd593c73833374c3e1a6d2643875ea1c54842dc0988fe2457ab
BLAKE2b-256 checksum
How to use checksums
d1a755ae478caa2dce13023cc498cb32248efc8efa7b4cc145ef81e6d67d8d45
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.11.6

Release files / rnamoip-1.1.2-py3-none-any.whl

Download URL rnamoip-1.1.2-py3-none-any.whl
Size 1.3 MB
Tags Python 3
SHA-256 checksum
How to use checksums
6a60f0df4270b22c3c96a7467fa49e9cdcbd8682fcfe9c12b4fddeb00c5211f7
BLAKE2b-256 checksum
How to use checksums
6d56e32a6a083db2ebe70989be2971bc38a4a3c19450002a3f96bc16b917909c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.11.6

Security for rnamoip 1.1.2

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