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.2.tar.gz (189.6 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.2-py3-none-any.whl (189.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: sborf-0.0.2.tar.gz
  • Upload date:
  • Size: 189.6 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.2.tar.gz
Algorithm Hash digest
SHA256 10c1c3857279968f039f9b567b1e8eb84d2355d92f81b134ebf1f01df6069845
MD5 e9322bb6edf6cc8fb6f5971ac099c9e6
BLAKE2b-256 e5d015b446b874278d02bc9cb4a1c831230b17ce3927bcce09680a474a9d1a0a

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sborf-0.0.2-py3-none-any.whl
  • Upload date:
  • Size: 189.7 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.2-py3-none-any.whl
Algorithm Hash digest
SHA256 091d76b2c3a0b179bd08829689d287a2bb5b695b9c30928e6c3124918f9c5372
MD5 a0d6b081c6d0c8d7a30a827809d549e4
BLAKE2b-256 b05901ce189f4ac5d2071371cf2328b350ff9b5829afda954e7e6167230860be

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