Skip to main content

A neural network that predicts and designs alternative DNA encodings for proteins, aiming to fine-tune their expression

Project description

logo


About sborf

Installation

Package installation should only take a few minutes with any of these methods (pip, source).

Installing sborf with pip:

We suggest to create a local conda environment where to install sborf. it can be done with:

conda create -n sborf

and activated with

conda activate sborf

or

source activate sborf

We also suggest to install pytorch separately following the instructions from https://pytorch.org/get-started/locally/

pip install sborf

The procedure will install sborf in your computer.

Installing sborf from source:

If you want to install sborf from this repository, you need to install the dependencies first. First, install PyTorch separately following the instructions from https://pytorch.org/get-started/locally/.

Then install the other required libraries:

pip install numpy scikit-learn requests

Finally, you can clone the repository with the following command:

git clone https://github.com/grogdrinker/sborf/

Usage

the pip installation will install a script called sborf_standalone that is directly usable from command line (at least on linux and mac. Most probably on windows as well if you use a conda environemnt).

Using the standalone

The script can take a fasta file or a sequence as input and provide a prediction as output

sborf_standalone AWESAMEPRTEINSEQENCEASINPT

or, for multiple sequences, do

sborf_standalone fastaFile.fasta

To write the output in a file, do

sborf_standalone fastaFile.fasta -o outputFilePath

Using sborf into a python script

sborf can be imported as a python module

from sborf.run_prediction import predict
proteinSeq1 = "ASDASDASDASDASDASDDDDASD"
proteinSeq2 = "ASDADDDDDDDDDDDDDASDASDDDDASD"
proteinSeq2 = "ASDADFFFFFFFFFDDDDDDDDFFFFFFFFFASD"
inputSequences = {"ID1":proteinSeq1,"ID2":proteinSeq2,"ID3":proteinSeq3}

sborf_output = predict(inputSequences) # which is a dict containig the predictions

Help

For bug reports, features addition and technical questions please contact gabriele.orlando@kuleuven.be

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

sborf-0.0.3.tar.gz (189.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

sborf-0.0.3-py3-none-any.whl (189.8 kB view details)

Uploaded Python 3

File details

Details for the file sborf-0.0.3.tar.gz.

File metadata

  • Download URL: sborf-0.0.3.tar.gz
  • Upload date:
  • Size: 189.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.4

File hashes

Hashes for sborf-0.0.3.tar.gz
Algorithm Hash digest
SHA256 92e46fa00837cc1f600f1faba3e4d6fa5bb46e30acfce4946913316c0192fa35
MD5 d59c75acee36f07b990fd2218ea7a3a8
BLAKE2b-256 4ec0f68a558bc6236182349ffe789c2ca4645f6b56497dbb5da0304459c1ad6b

See more details on using hashes here.

File details

Details for the file sborf-0.0.3-py3-none-any.whl.

File metadata

  • Download URL: sborf-0.0.3-py3-none-any.whl
  • Upload date:
  • Size: 189.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.4

File hashes

Hashes for sborf-0.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 539df92437eb76903e4eaa8b57a0f31250e0269d511d97b143c8c56e130bf4a3
MD5 90908f6bc213b2b8403090bf827b0a2c
BLAKE2b-256 96ec479a23a6fe84d560314155f67599772de28a2eb70fc1ed8d7cddccc668ea

See more details on using hashes here.

Supported by

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