Skip to main content

A tool to get structural information about light chain amyloids

Project description

logo


About HMMSTUFF

HMMSTUFF is a tool to help researchers to make the best use of the limited data available about light chain amyloids. Given a light chain amyloid, it tells you if there is a similar chain with experimentally solved structure.

If you use HMMSTUFF in your research, please consider citing:

Installation

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

A foldX binary, which can be downloaded from https://foldxsuite.crg.eu/, is required

Installing HMMSTUFF:

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

conda create -n hmmstuff python=3.7

and activated with

conda activate hmmstuff

or

source activate hmmstuff

Finally, install hmmstuff using

pip install hmmstuff

The procedure will install hmmstuff in your computer.

Using HMMSTUFF into a python script

the pip installation will install a python library that is directly usable (at least on linux and mac. Most probably on windows as well if you use a conda environemnt).

HMMSTUFF can be imported as a python module

from HMMSTUFF.HMMSTUFF import HMMSTUFF # import the library
# put your input sequences in a dictionary
sequences = {"seq1":"AVSVALGQTVRITCQGDSLRSYSASWYEEKPGQAPVLVIFRAAAARFSGSSSGNTASLTITGAQAEDEADYYCNSRDSSANHQAAAAVFGGGTKLTV",
             "seq2":"AVSVALGQTVRITCQGDSLRSYSASWYQQKPGQAPVLVIFRAAAARFSGSSSGNTASLTITGAQAEDEADYYCNSRDSSANHVFGGGTKLTV",
             "seq3":"SELTQDPAVSVALGQTVRITCQGDSLRSYYASWYQQKSGQAPVLVIYSYNNRPSGIPDRFSGSNSGNTASLTITGAQAEDEADYYCNSRDSSGHHLVFGGGTKLTVLGQPKAAPS",
             "seq4":"MKYLLPTAAAGLLL"} 

hmmstuff = HMMSTUFF() # create the main HMMSTUFF object

# to get a fast evaluation of the sequences, run:
results = hmmstuff.evaluate_sequences(sequences)

results will be a dictionary with as key the name of the input sequences (in the previous example "seq1", "seq2" ...). Each entry is again a dictionary with the predicted information:

  • best_template_name: is the best template for the input sequence (even if not good enouth to run a structure)
  • doable: if True, it means that the template is simmilar enough to build a model of the amyloid by homology.
  • substrings: is the portion of the input sequence that can be aligned with a template without gaps, with the exception of the parts missing in the PDB
  • score: The score of the template-input sequence alignment generated by HMMSTUFF. It goes from 0 to 1 and it tells how similar the input sequence is to the template.
  • alignment: is a tuple containing the aligmnet between the input sequence and the template sequence, generated with the HMM of HMMSTUFF.

To get an evaluation of the sequences, and eventually run the structure prediction, run:

results = hmmstuff.predict_structures(sequences,foldx_bin="Your/FoldX/Bin/path",folder_out_pdbs="Your/output/path/")

where foldx_bin is the path to the foldX 4 binary file and folder_out_pdbs is the path of the folder where the homology models are going to be stored.

In this case, the results of each input sequence will feature two additional information

-energy: the energy of the model calculated by FoldX

-pdb_file: The path of the homology models PDB file

Remember that for this study, foldX 4 has been used and a Rotabase.txt file is required to be found in the same folder of the FoldX binary. The code might work with FoldX5 as well, but it has not been tested.

Help

For bug reports, features addition and technical questions please contact orlando.gabriele89@gmail.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

hmmstuff-1.0.0.tar.gz (613.1 kB view details)

Uploaded Source

Built Distribution

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

hmmstuff-1.0.0-py3-none-any.whl (614.6 kB view details)

Uploaded Python 3

File details

Details for the file hmmstuff-1.0.0.tar.gz.

File metadata

  • Download URL: hmmstuff-1.0.0.tar.gz
  • Upload date:
  • Size: 613.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.9.16

File hashes

Hashes for hmmstuff-1.0.0.tar.gz
Algorithm Hash digest
SHA256 9eb69c32da26a972aa0c0af98eb98b186fd9c3ca57bbd5918560ddeabcc8cbba
MD5 ccad5dff58f82e23be164818f6bad079
BLAKE2b-256 31c07240516a58f622e187652d1a78516330049c8625f544429e8dfd57f9ead8

See more details on using hashes here.

File details

Details for the file hmmstuff-1.0.0-py3-none-any.whl.

File metadata

  • Download URL: hmmstuff-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 614.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.9.16

File hashes

Hashes for hmmstuff-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 c3c19ab26403fbf32a79f3f7b8bd950a8f8ad225f47295fbaced3a607a6e2939
MD5 d2a2e4cc6601d88cf59977bb38a580ed
BLAKE2b-256 85ae5408128a87c3303573004276d9e95e366b253b7f8267cb574044e2b17a4c

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