Skip to main content

rSNAPed

rSNAPed : RNA Sequence to NAscent Protein Experiment Designer.

Authors: Luis U. Aguilera, William Raymond, Brooke Silagy, Brian Munsky.

License: MIT

⚠️ This software is in a very early and experimental stage: at this point, it is intended to be used for testing and debugging purposes!

Description

This library is intended to quantify single-molecule gene expression experiments. Specifically, the code uses Cellpose to segment the cell in the image. Then, it uses Trackpy to detect spots inside the mask. Finally, it uses the spot position to quantify the spot intensity. The code also generates simulated data using rSNAPsim. If you use rSNAPed, please make sure you properly cite cellpose, trackpy and rSNAPsim.

Usage

  • Tracking for single-molecule translation (RNA + nascent protein) spots.
  • Tracking for single-molecule RNA spots.
  • Simulating the single-molecule translation for any gene.
  • Design of single-molecule gene expression experiments.

Simulating translation

The code is intended to simulated single-molecule translation. A video with the simulated cell and a data frame containing spot and intensity positions are generated. This simulation can be used to train new algorithms or for teaching new students.

Local installation using PIP

  • To create a virtual environment using:
    conda create -n rsnaped_env python=3.8.5 -y
    source activate rsnaped_env
  • Open the terminal and use pip for the installation:
    pip install rsnaped

Local installation from the Github repository

  • To create a virtual environment navigate to the location of the requirements file, and use:
    conda create -n rsnaped_env python=3.8.5 -y
    source activate rsnaped_env
  • To install GPU for Cellpose (Optional step). Only for Linux and Windows users check the specific version for your computer on this link :
    conda install pytorch cudatoolkit=10.2 -c pytorch -y
  • To install CPU for Cellpose (Optional step). Only for Mac users check the specific version for your computer on this link :
    conda install pytorch -c pytorch
  • To include the rest of requirements use:
    pip install -r requirements.txt

Additional steps to deactivate or remove the environment from the computer:

  • To deactivate the environment use
    conda deactivate
  • To remove the environment use:
    conda env remove -n rsnaped_env

References for main dependencies

  • rSNAPsim: Aguilera, Luis U., et al. "Computational design and interpretation of single-RNA translation experiments." PLoS computational biology 15.10 (2019): e1007425.

  • Trackpy: Dan Allan, et al. (2019, October 16). soft-matter/trackpy: Trackpy v0.4.2 (Version v0.4.2). Zenodo. http://doi.org/10.5281/zenodo.3492186

  • Cellpose: Stringer, Carsen, et al. "Cellpose: a generalist algorithm for cellular segmentation." Nature Methods 18.1 (2021): 100-106.

Licenses for dependencies

For a complete list containing the complete licenses for the dependencies, check file: Licenses_Dependencies.txt.

  • License for rSNAPsim: MIT. Copyright © 2018 Dr. Luis Aguilera, William Raymond
  • License for Trackpy: BSD-3-Clause. Copyright © 2013-2014 trackpy contributors https://github.com/soft-matter/trackpy. All rights reserved.
  • License for Cellpose: BSD 3-Clause. Copyright © 2020 Howard Hughes Medical Institute

Metadata

Release files for rsnaped 0.1.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 rsnaped 0.1.0
File Size Uploaded Provenance Actions
rsnaped-0.1.0.tar.gz 43.6 kB Without provenance Details for rsnaped-0.1.0.tar.gz

Built distribution (wheel)

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

Total release size: 85.2 kB

Release files / rsnaped-0.1.0.tar.gz

Download URL rsnaped-0.1.0.tar.gz
Size 43.6 kB
Tags Source
SHA-256 checksum
How to use checksums
616330f10460561913fff283400e1bb36ac28dc762c89dca40c87de657210a12
BLAKE2b-256 checksum
How to use checksums
fbc5cfa5fc1ea72ccc2a07870be86370919fa826280e50cac46089ab32720d13
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/54.2.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.8.5

Release files / rsnaped-0.1.0-py3-none-any.whl

Download URL rsnaped-0.1.0-py3-none-any.whl
Size 41.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
efe4bae4df730e9bcb941f807df5c4ad1b4b08e190ca2ce2f55d12de721c921e
BLAKE2b-256 checksum
How to use checksums
6da4368ad907ddf8c1d3766c37edf6327b261b2474d157d4a8469df093017009
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/54.2.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.8.5

Security for rsnaped 0.1.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