mutadock


Namemutadock JSON
Version 1.9.3 PyPI version JSON
download
home_pageNone
SummaryMUTADOCK is a comprehensive library designed for mutation studies and multiple receptor-ligand docking. Refer to README for more information.
upload_time2024-09-27 15:30:07
maintainerNone
docs_urlNone
authorNone
requires_pythonNone
licenseGPL-3.0
keywords bioinformatics biology docking mutation
VCS
bugtrack_url
requirements None biopython meeko numpy pyrosetta-installer tqdm pyarrow pandas
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # MUTADOCK

## Introduction
MUTADOCK is a comprehensive library designed for mutation studies and multiple receptor-ligand docking. It provides tools and methods to analyze and predict the effects of mutations on receptor-ligand interactions, enabling researchers to study protein function and drug binding affinity in a detailed manner.

### Description
Our software is designed to facilitate protein mutation analysis and molecular docking. It integrates automated protein mutation using PyRosetta and a docking library capable of docking multiple proteins with multiple ligands. 

### Key Features
#### Automated Protein Mutation:
- Utilizes PyRosetta for systematic protein mutations.
- Supports various mutation strategies (e.g., single-point mutations, double-point mutations and triple-point mutations).
- Allows customization of mutation and docking parameters.
#### Docking Library:
- Capable of docking a list of proteins against a list of ligands.
- Employs AutoDock Vina to predict binding affinities and best poses.
- Provides detailed output files with docking scores and poses.
#### User Interface:
- **Command-Line Interface:** Simple CLI for both beginner and expert users.
- **Python Bindings:** The library can be imported in other codes for increased customizability by expert users


## Try it Now
The basic codes to perform mutation studies as used by us for our project can be found in a Jupyter Notebook here. The same notebook can be found on collab here.

## How To Guide

### Installation
MutaDock has been deployed on PyPi, making installation quick and simple
```
pip install mutadock
```

The Pyrosetta Installer will be automatically installed but Pyrosetta should be installed using
```
md_install_dependencies
```
this will install all dependencies including Pyrosetta.

- Currently there is a problem with the vina on PyPi, so vina needs to be installed separately, the installation guide can be found at https://autodock-vina.readthedocs.io/en/latest/installation.html


### Mutation Studies
Mutation Studies for a protein is a very fast process with just a PDB file of the protein as the input. (We assume for the tutorial that the name of the PDB file is “protein.pdb”)

```
md_mutate -i protein.pdb
```

Other optional arguments can be changed as required, to check the usage run 
```
md_mutate -h
```

The md_mutate will output CSV files and one text file, their description is in the table below:
| **No.** | **File Name**                           | **Description**                                                                                       |
|-----|-------------------------------------|---------------------------------------------------------------------------------------------------|
| 1.  | protein_modified_mutations_all.csv  | Contains all possible mutations for the given protein                                             |
| 2.  | protein_modified_mutations.csv      | Contains mutations that are possible according to the PAM matrix for the given protein            |
| 3.  | protein_modified_mutations_ddG.csv  | The single mutation ddG values for the mutation in the File-2                                      |
| 4.  | protein_modified_mutations_ddG_sorted.csv | Sorted File-3 from lowest to highest ddG values                                               |
| 5.  | protein_modified_double_ddg.csv     | The ddG values of the double mutation for all the combinations of the most negative single ddG compounds |
| 6.  | protein_modified_double_ddg_sorted.csv | Sorted File-5 from lowest to highest ddG values                                               |
| 7.  | protein_modified_triple_ddg.csv     | The ddG values of the triple mutation for all the combinations of the most negative double ddG compounds |
| 8.  | protein_modified_triple_ddg_sorted.csv | Sorted File-7 from lowest to highest ddG values                                               |
| 9.  | protein_modified_mutants.txt        | Generates a list of all the mutated PDB files created. Can be directly used as input for the md_dock command in our mutadock library |


### Docking Studies
Docking for multiple receptors and ligands is made simple and efficient by mutadock. The text files containing the names of the receptors and ligands need to be given as input, after that everything is automated. (If md_mutate is used, the text file for receptor is generated automatically)
Every receptor in the receptor file will be docked with every ligand in the ligand file. A standard Vina configuration file or an AutoSIte prediction output is required.
Example:
```
md_dock -r receptors.txt -l ligands.txt -c config.txt
```
Other optional arguments can be changed as required, to check the usage run 
```
md_dock -h
```
The output of md_dock with their description is in the table below:
| **No.** | **Output**              | **Description**                                                                                       |
|-----|---------------------|---------------------------------------------------------------------------------------------------|
| 1.  | PDBQT files         | The receptors and ligands will be converted to PDBQT files for AutoDock Vina.                     |
| 2.  | Output Log          | The output of AutoDock Vina with the docking scores will be stored in a log file for each combination. |
| 3.  | Output PDB          | The output of AutoDock Vina with the 5 best docking poses will be stored in a PDB file for each combination. |
| 4.  | Output PDBQT        | The output of AutoDock Vina Split with the best pose will be stored in a PDBQT file for each combination. |
| 5.  | Output SDF          | The best pose after docking will be stored in a SDF file for visualization and better usability.  |
| 6.  | Docking Results CSV | All the docking affinities are tabulated in a CSV to make analysis trivial.                       |


### All CLI Scripts
| **No.** | **Command**            | **Description**                                                                           |
|-----|--------------------|---------------------------------------------------------------------------------------|
| 1.  | md_mutate          | Predicts the best mutation of the given protein                                       |
| 2.  | md_dock            | Docked all combinations from a list of receptors and ligands                          |
| 3.  | md_vina_dock       | CLI for AutoDock Vina                                                                 |
| 4.  | md_csv_generator   | Generates all possible mutations for a protein and also the mutations possible according to PAM Matrix |
| 5.  | md_csv_sort        | Can sort any CSV file according to the column name or number chosen                   |
| 6.  | md_ddg_single      | Calculates single ddG values for a given CSV of mutations                             |
| 7.  | md_ddg_double      | Calculates double ddG values for all combinations using a given CSV of mutations      |
| 8.  | md_ddg_triple      | Calculates triple ddG values for all combinations using a given CSV of mutations      |


## Applications
- **Protein Engineering:** Designing mutated proteins with enhanced stability or new functionalities.
- **Drug Discovery:** Screening potential drug candidates by predicting binding affinities.
- **Biochemical Research:** Studying protein-ligand interactions to understand biological processes.


## Documentation
- README is included in the repository to serve as a comprehensive guide
- ReadtheDocs Page for updated documentation can be found [here](https://mutadock.readthedocs.io/en/latest/#)


## Future Developments
- **Developing a Graphical User Interface (GUI):** Enhancing user experience by providing a user-friendly interface for easier interaction with the software.
- **Creating a Web Server:** Allowing remote access and usage of the software through a web-based platform, making it accessible from anywhere.
- **Increasing Parameter Customizability:** Offering more options for users to fine-tune mutation and docking parameters to suit specific research needs and conditions.


## Acknowledgements
- Open-source tools and libraries used in the development.


## Contact
- For questions, suggestions, or collaboration, please contact [Naisarg Patel](mailto:naisarg.patel14@hotmail.com).

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "mutadock",
    "maintainer": null,
    "docs_url": null,
    "requires_python": null,
    "maintainer_email": null,
    "keywords": "Bioinformatics, Biology, Docking, Mutation",
    "author": null,
    "author_email": "Naisarg Patel <naisarg.patel14@hotmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/62/2c/7cd0eb821cf76eadfb26262a4cda85ab50ce23f517e125c54b39f7cb1e9b/mutadock-1.9.3.tar.gz",
    "platform": null,
    "description": "# MUTADOCK\n\n## Introduction\nMUTADOCK is a comprehensive library designed for mutation studies and multiple receptor-ligand docking. It provides tools and methods to analyze and predict the effects of mutations on receptor-ligand interactions, enabling researchers to study protein function and drug binding affinity in a detailed manner.\n\n### Description\nOur software is designed to facilitate protein mutation analysis and molecular docking. It integrates automated protein mutation using PyRosetta and a docking library capable of docking multiple proteins with multiple ligands. \n\n### Key Features\n#### Automated Protein Mutation:\n- Utilizes PyRosetta for systematic protein mutations.\n- Supports various mutation strategies (e.g., single-point mutations, double-point mutations and triple-point mutations).\n- Allows customization of mutation and docking parameters.\n#### Docking Library:\n- Capable of docking a list of proteins against a list of ligands.\n- Employs AutoDock Vina to predict binding affinities and best poses.\n- Provides detailed output files with docking scores and poses.\n#### User Interface:\n- **Command-Line Interface:** Simple CLI for both beginner and expert users.\n- **Python Bindings:** The library can be imported in other codes for increased customizability by expert users\n\n\n## Try it Now\nThe basic codes to perform mutation studies as used by us for our project can be found in a Jupyter Notebook here. The same notebook can be found on collab here.\n\n## How To Guide\n\n### Installation\nMutaDock has been deployed on PyPi, making installation quick and simple\n```\npip install mutadock\n```\n\nThe Pyrosetta Installer will be automatically installed but Pyrosetta should be installed using\n```\nmd_install_dependencies\n```\nthis will install all dependencies including Pyrosetta.\n\n- Currently there is a problem with the vina on PyPi, so vina needs to be installed separately, the installation guide can be found at https://autodock-vina.readthedocs.io/en/latest/installation.html\n\n\n### Mutation Studies\nMutation Studies for a protein is a very fast process with just a PDB file of the protein as the input. (We assume for the tutorial that the name of the PDB file is \u201cprotein.pdb\u201d)\n\n```\nmd_mutate -i protein.pdb\n```\n\nOther optional arguments can be changed as required, to check the usage run \n```\nmd_mutate -h\n```\n\nThe md_mutate will output CSV files and one text file, their description is in the table below:\n| **No.** | **File Name**                           | **Description**                                                                                       |\n|-----|-------------------------------------|---------------------------------------------------------------------------------------------------|\n| 1.  | protein_modified_mutations_all.csv  | Contains all possible mutations for the given protein                                             |\n| 2.  | protein_modified_mutations.csv      | Contains mutations that are possible according to the PAM matrix for the given protein            |\n| 3.  | protein_modified_mutations_ddG.csv  | The single mutation ddG values for the mutation in the File-2                                      |\n| 4.  | protein_modified_mutations_ddG_sorted.csv | Sorted File-3 from lowest to highest ddG values                                               |\n| 5.  | protein_modified_double_ddg.csv     | The ddG values of the double mutation for all the combinations of the most negative single ddG compounds |\n| 6.  | protein_modified_double_ddg_sorted.csv | Sorted File-5 from lowest to highest ddG values                                               |\n| 7.  | protein_modified_triple_ddg.csv     | The ddG values of the triple mutation for all the combinations of the most negative double ddG compounds |\n| 8.  | protein_modified_triple_ddg_sorted.csv | Sorted File-7 from lowest to highest ddG values                                               |\n| 9.  | protein_modified_mutants.txt        | Generates a list of all the mutated PDB files created. Can be directly used as input for the md_dock command in our mutadock library |\n\n\n### Docking Studies\nDocking for multiple receptors and ligands is made simple and efficient by mutadock. The text files containing the names of the receptors and ligands need to be given as input, after that everything is automated. (If md_mutate is used, the text file for receptor is generated automatically)\nEvery receptor in the receptor file will be docked with every ligand in the ligand file. A standard Vina configuration file or an AutoSIte prediction output is required.\nExample:\n```\nmd_dock -r receptors.txt -l ligands.txt -c config.txt\n```\nOther optional arguments can be changed as required, to check the usage run \n```\nmd_dock -h\n```\nThe output of md_dock with their description is in the table below:\n| **No.** | **Output**              | **Description**                                                                                       |\n|-----|---------------------|---------------------------------------------------------------------------------------------------|\n| 1.  | PDBQT files         | The receptors and ligands will be converted to PDBQT files for AutoDock Vina.                     |\n| 2.  | Output Log          | The output of AutoDock Vina with the docking scores will be stored in a log file for each combination. |\n| 3.  | Output PDB          | The output of AutoDock Vina with the 5 best docking poses will be stored in a PDB file for each combination. |\n| 4.  | Output PDBQT        | The output of AutoDock Vina Split with the best pose will be stored in a PDBQT file for each combination. |\n| 5.  | Output SDF          | The best pose after docking will be stored in a SDF file for visualization and better usability.  |\n| 6.  | Docking Results CSV | All the docking affinities are tabulated in a CSV to make analysis trivial.                       |\n\n\n### All CLI Scripts\n| **No.** | **Command**            | **Description**                                                                           |\n|-----|--------------------|---------------------------------------------------------------------------------------|\n| 1.  | md_mutate          | Predicts the best mutation of the given protein                                       |\n| 2.  | md_dock            | Docked all combinations from a list of receptors and ligands                          |\n| 3.  | md_vina_dock       | CLI for AutoDock Vina                                                                 |\n| 4.  | md_csv_generator   | Generates all possible mutations for a protein and also the mutations possible according to PAM Matrix |\n| 5.  | md_csv_sort        | Can sort any CSV file according to the column name or number chosen                   |\n| 6.  | md_ddg_single      | Calculates single ddG values for a given CSV of mutations                             |\n| 7.  | md_ddg_double      | Calculates double ddG values for all combinations using a given CSV of mutations      |\n| 8.  | md_ddg_triple      | Calculates triple ddG values for all combinations using a given CSV of mutations      |\n\n\n## Applications\n- **Protein Engineering:** Designing mutated proteins with enhanced stability or new functionalities.\n- **Drug Discovery:** Screening potential drug candidates by predicting binding affinities.\n- **Biochemical Research:** Studying protein-ligand interactions to understand biological processes.\n\n\n## Documentation\n- README is included in the repository to serve as a comprehensive guide\n- ReadtheDocs Page for updated documentation can be found [here](https://mutadock.readthedocs.io/en/latest/#)\n\n\n## Future Developments\n- **Developing a Graphical User Interface (GUI):** Enhancing user experience by providing a user-friendly interface for easier interaction with the software.\n- **Creating a Web Server:** Allowing remote access and usage of the software through a web-based platform, making it accessible from anywhere.\n- **Increasing Parameter Customizability:** Offering more options for users to fine-tune mutation and docking parameters to suit specific research needs and conditions.\n\n\n## Acknowledgements\n- Open-source tools and libraries used in the development.\n\n\n## Contact\n- For questions, suggestions, or collaboration, please contact [Naisarg Patel](mailto:naisarg.patel14@hotmail.com).\n",
    "bugtrack_url": null,
    "license": "GPL-3.0",
    "summary": "MUTADOCK is a comprehensive library designed for mutation studies and multiple receptor-ligand docking. Refer to README for more information.",
    "version": "1.9.3",
    "project_urls": {
        "Documentation": "https://mutadock.readthedocs.io/en/latest/",
        "Issues": "https://github.com/naisarg14/mutadock/issues",
        "Repository": "https://github.com/naisarg14/mutadock"
    },
    "split_keywords": [
        "bioinformatics",
        " biology",
        " docking",
        " mutation"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "ca03f431d53859e9e5b4978365131cb6f188c0515e06cdda076a2555e4343738",
                "md5": "2c841faa55b26532fa379a34e8ec0cef",
                "sha256": "89bd224572908f6b550d86c220c344da94211c464fbdc12524cabae25f609e62"
            },
            "downloads": -1,
            "filename": "mutadock-1.9.3-py2.py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "2c841faa55b26532fa379a34e8ec0cef",
            "packagetype": "bdist_wheel",
            "python_version": "py2.py3",
            "requires_python": null,
            "size": 49372,
            "upload_time": "2024-09-27T15:30:04",
            "upload_time_iso_8601": "2024-09-27T15:30:04.029170Z",
            "url": "https://files.pythonhosted.org/packages/ca/03/f431d53859e9e5b4978365131cb6f188c0515e06cdda076a2555e4343738/mutadock-1.9.3-py2.py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "622c7cd0eb821cf76eadfb26262a4cda85ab50ce23f517e125c54b39f7cb1e9b",
                "md5": "42fd8f78d03c7a5dd42195de51df789a",
                "sha256": "51c67ee10f4d71fd7c7eaa340fcbabcd873479c70f95a4859b4a114d394c37b5"
            },
            "downloads": -1,
            "filename": "mutadock-1.9.3.tar.gz",
            "has_sig": false,
            "md5_digest": "42fd8f78d03c7a5dd42195de51df789a",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 78131,
            "upload_time": "2024-09-27T15:30:07",
            "upload_time_iso_8601": "2024-09-27T15:30:07.188018Z",
            "url": "https://files.pythonhosted.org/packages/62/2c/7cd0eb821cf76eadfb26262a4cda85ab50ce23f517e125c54b39f7cb1e9b/mutadock-1.9.3.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-09-27 15:30:07",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "naisarg14",
    "github_project": "mutadock",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [
        {
            "name": null,
            "specs": []
        },
        {
            "name": "biopython",
            "specs": [
                [
                    "==",
                    "1.84"
                ]
            ]
        },
        {
            "name": "meeko",
            "specs": [
                [
                    "==",
                    "0.5.0"
                ]
            ]
        },
        {
            "name": "numpy",
            "specs": [
                [
                    ">=",
                    "2.1.1"
                ]
            ]
        },
        {
            "name": "pyrosetta-installer",
            "specs": [
                [
                    "==",
                    "0.1.1"
                ]
            ]
        },
        {
            "name": "tqdm",
            "specs": [
                [
                    ">=",
                    "4.66.5"
                ]
            ]
        },
        {
            "name": "pyarrow",
            "specs": [
                [
                    "==",
                    "17.0.0"
                ]
            ]
        },
        {
            "name": "pandas",
            "specs": [
                [
                    "==",
                    "2.2.2"
                ]
            ]
        }
    ],
    "lcname": "mutadock"
}
        
Elapsed time: 0.29039s