Installation

Prior to installation it is recommended users create a separate environment to run the package. Given the presence of NUPACK, python=3.10 is recommended. TM-SmiRs has been published on PyPI and can therefore be easily installed either through github, or using pip:

Easy installation:

    1. Install via PyPI. The package has been published; download should be straightforward.

pip install tm-smirs

Once installed, tm-smirs can directly be imported using:

import tm-smirs as ts

Specific submodules may also be installed individually e.g.:

from tm-smirs.data import read_miRNA_sqlite

Full-access installation:

    1. Alternatively, clone the repo if full access is desired:

git clone https://github.com/ilv18/tm-smirs.git
cd tm-smirs

  1. Install dependencies in a single call:

pip install -e .

  1. (Optional) Set `PYTHONPATH` for direct `python -m` runs

export PYTHONPATH=$PWD/src