Metadata-Version: 2.1
Name: bemm-gen
Version: 2024.10.10
Summary: Biomolecular Environment Mimicking Model GENerator
Author-email: Takunori Yasuda <yasuda.takunori.tkb_gb@u.tsukuba.ac.jp>, Rikuri Morita <mriky.25@gmail.com>
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.
        
Project-URL: Homepage, https://github.com/y4suda/BEMM-GEN
Project-URL: Repository, https://github.com/y4suda/BEMM-GEN
Project-URL: Issues, https://github.com/y4suda/BEMM-GEN/issues
Keywords: bioinfomatic,molecular dynamics,biology,chemoinformatics
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Development Status :: 4 - Beta
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: scikit-learn
Requires-Dist: rdkit
Requires-Dist: parmed

<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 for Molecular Dynamics Simulation", *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 
