bemm-gen


Namebemm-gen JSON
Version 2024.7.26 PyPI version JSON
download
home_pageNone
SummaryBiomolecular Environment Mimicking Model GENerator
upload_time2024-07-26 01:56:10
maintainerNone
docs_urlNone
authorNone
requires_python>=3.9
licenseMIT License Copyright (c) 2024 y4suda Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
keywords bioinfomatic molecular dynamics biology chemoinformatics
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            <p align="center"><br><img src="./bemm-gen_logo_horizontal.png" width="512px"><br><br>
Biomolecular  Environment Mimicking Model GENerator <br><br><br></p>

# Welcome to BEMM-GEN
<p align="center"><br><img src="./bemm-gen_main.png" width="800px"></p>


## What is BEMM-GEN?
<img src="./bemm-gen_scheme.png" align="right" width="400px">
BEMM-GEN is a new tool aiming to generate biomolecular  environment mimicking model for molecular dynamics simulation. BEMM-GEN generates spherical and cylindrical models with user-specified chemical properties, allowing the integration of arbitrary protein structures into the generated models. Consequently, the model and protein complex structures, along with the corresponding parameter files for MD simulations (AMBER or GROMACS), are provided as output files. 
<br><br><br><br><br><br><br><br><br>

## Requirements
Python >= 3.8, conda, openbabel, psi4, resp, ambertools, scikit-learn, rdkit, parmed 

## Installation 
### For Linux/MacOS
- Follow the instructions below to install BEMM-GEN.
### For Windows
- Install Windows Subsystem for Linux (WSL), then follow the instructions below to install BEMM-GEN on WSL.


Using a Conda environment (such as Miniforge, or Miniconda) is recommended for BEMM-GEN. If you use only the pip package manager, please adjust the commands accordingly.
```sh
conda create -n bemm-gen-env
conda activate bemm-gen-env
conda install -c conda-forge openbabel psi4 resp ambertools
pip install bemm-gen
```
## Basic Usage
```sh:available_sub-commands
# Make a cylindrical model
bemm-gen cylinder --proteinseq GASGASGASGAS --proteinSS HHHHHHHHHHHH --resnames MTY:HYD --composition 1:2.5

# Make a spherical model
bemm-gen sphere --proteinpdb protein.pdb --resnames MTY:HYD --composition 0.3:0.7

# Make parameters for a new residue
bemm-gen makeparam --smiles CCC --resname MTY --description "Methyl group"
```

**Please see the documentation [English](https://github.com/y4suda/BEMM-GEN/blob/main/tutorial_en.md) / [日本語](https://github.com/y4suda/BEMM-GEN/blob/main/tutorial_ja.md)**

## Cite Us
T. Yasuda, R. Morita, Y. Shigeta and R. Harada. "BEMM-GEN : A toolkit for generating a biomolecular  environment mimicking model."*XXXX*,2024,XXXX,[doi](https://XXX)

## Authors
Takunori Yasuda, Doctoral Program in Biology, University of Tsukuba
Rikuri Morita, Center for Computational Sciences, University of Tsukuba  
Yasuteru Shigeta, Center for Computational Sciences, University of Tsukuba  
Ryuhei Harada, Center for Computational Sciences, University of Tsukuba  
yasuda.takunori.tkb_gb@u.tsukuba.ac.jp 

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "bemm-gen",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.9",
    "maintainer_email": null,
    "keywords": "bioinfomatic, molecular dynamics, biology, chemoinformatics",
    "author": null,
    "author_email": "Takunori Yasuda <yasuda.takunori.tkb_gb@u.tsukuba.ac.jp>, Rikuri Morita <mriky.25@gmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/28/2e/72c0187e6a2a961383ed18504908331e874d0b6d32ea4b028a77665d6f3c/bemm_gen-2024.7.26.tar.gz",
    "platform": null,
    "description": "<p align=\"center\"><br><img src=\"./bemm-gen_logo_horizontal.png\" width=\"512px\"><br><br>\nBiomolecular  Environment Mimicking Model GENerator <br><br><br></p>\n\n# Welcome to BEMM-GEN\n<p align=\"center\"><br><img src=\"./bemm-gen_main.png\" width=\"800px\"></p>\n\n\n## What is BEMM-GEN?\n<img src=\"./bemm-gen_scheme.png\" align=\"right\" width=\"400px\">\nBEMM-GEN is a new tool aiming to generate biomolecular  environment mimicking model for molecular dynamics simulation. BEMM-GEN generates spherical and cylindrical models with user-specified chemical properties, allowing the integration of arbitrary protein structures into the generated models. Consequently, the model and protein complex structures, along with the corresponding parameter files for MD simulations (AMBER or GROMACS), are provided as output files. \n<br><br><br><br><br><br><br><br><br>\n\n## Requirements\nPython >= 3.8, conda, openbabel, psi4, resp, ambertools, scikit-learn, rdkit, parmed \n\n## Installation \n### For Linux/MacOS\n- Follow the instructions below to install BEMM-GEN.\n### For Windows\n- Install Windows Subsystem for Linux (WSL), then follow the instructions below to install BEMM-GEN on WSL.\n\n\nUsing a Conda environment (such as Miniforge, or Miniconda) is recommended for BEMM-GEN. If you use only the pip package manager, please adjust the commands accordingly.\n```sh\nconda create -n bemm-gen-env\nconda activate bemm-gen-env\nconda install -c conda-forge openbabel psi4 resp ambertools\npip install bemm-gen\n```\n## Basic Usage\n```sh:available_sub-commands\n# Make a cylindrical model\nbemm-gen cylinder --proteinseq GASGASGASGAS --proteinSS HHHHHHHHHHHH --resnames MTY:HYD --composition 1:2.5\n\n# Make a spherical model\nbemm-gen sphere --proteinpdb protein.pdb --resnames MTY:HYD --composition 0.3:0.7\n\n# Make parameters for a new residue\nbemm-gen makeparam --smiles CCC --resname MTY --description \"Methyl group\"\n```\n\n**Please see the documentation [English](https://github.com/y4suda/BEMM-GEN/blob/main/tutorial_en.md) / [\u65e5\u672c\u8a9e](https://github.com/y4suda/BEMM-GEN/blob/main/tutorial_ja.md)**\n\n## Cite Us\nT. Yasuda, R. Morita, Y. Shigeta and R. Harada. \"BEMM-GEN : A toolkit for generating a biomolecular  environment mimicking model.\"*XXXX*,2024,XXXX,[doi](https://XXX)\n\n## Authors\nTakunori Yasuda, Doctoral Program in Biology, University of Tsukuba\nRikuri Morita, Center for Computational Sciences, University of Tsukuba  \nYasuteru Shigeta, Center for Computational Sciences, University of Tsukuba  \nRyuhei Harada, Center for Computational Sciences, University of Tsukuba  \nyasuda.takunori.tkb_gb@u.tsukuba.ac.jp \n",
    "bugtrack_url": null,
    "license": "MIT License  Copyright (c) 2024 y4suda  Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:  The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.  THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
    "summary": "Biomolecular Environment Mimicking Model GENerator",
    "version": "2024.7.26",
    "project_urls": {
        "Homepage": "https://github.com/y4suda/BEMM-GEN",
        "Issues": "https://github.com/y4suda/BEMM-GEN/issues",
        "Repository": "https://github.com/y4suda/BEMM-GEN"
    },
    "split_keywords": [
        "bioinfomatic",
        " molecular dynamics",
        " biology",
        " chemoinformatics"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "fcac212f9f10ac51ed47d979b1ac2a6ad1c34ccf1a34d24bcd62fd6e9dc9c4b7",
                "md5": "c67acbddff8167394716691cbd125823",
                "sha256": "35d809882a4e836c095affdc6a311f3b2ebc5925d8008e03e1757a452715343d"
            },
            "downloads": -1,
            "filename": "bemm_gen-2024.7.26-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "c67acbddff8167394716691cbd125823",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9",
            "size": 1118848,
            "upload_time": "2024-07-26T01:56:08",
            "upload_time_iso_8601": "2024-07-26T01:56:08.485390Z",
            "url": "https://files.pythonhosted.org/packages/fc/ac/212f9f10ac51ed47d979b1ac2a6ad1c34ccf1a34d24bcd62fd6e9dc9c4b7/bemm_gen-2024.7.26-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "282e72c0187e6a2a961383ed18504908331e874d0b6d32ea4b028a77665d6f3c",
                "md5": "b9b7bfbb62d6d41a84990b8182f683e1",
                "sha256": "849c63dcde4b68bace3452b18f42b287280e179efaf97178cfadec66e6a31ffa"
            },
            "downloads": -1,
            "filename": "bemm_gen-2024.7.26.tar.gz",
            "has_sig": false,
            "md5_digest": "b9b7bfbb62d6d41a84990b8182f683e1",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9",
            "size": 1068189,
            "upload_time": "2024-07-26T01:56:10",
            "upload_time_iso_8601": "2024-07-26T01:56:10.686192Z",
            "url": "https://files.pythonhosted.org/packages/28/2e/72c0187e6a2a961383ed18504908331e874d0b6d32ea4b028a77665d6f3c/bemm_gen-2024.7.26.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-07-26 01:56:10",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "y4suda",
    "github_project": "BEMM-GEN",
    "github_not_found": true,
    "lcname": "bemm-gen"
}
        
Elapsed time: 0.32933s