| Name | COBY JSON |
| Version |
0.2.3
JSON |
| download |
| home_page | None |
| Summary | Build coarse-grained molecular systems |
| upload_time | 2024-12-12 08:58:52 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.9 |
| license | None |
| keywords |
building
dynamics
martini
molecular
system
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Coarse-grained System Builder (COBY)
The paper is currently in pre-print at [bioRxiv](https://www.biorxiv.org/content/10.1101/2024.07.23.604601v1).
The program as well as documentation and a tutorial is avialable on the [GitHub](https://github.com/MikkelDA/COBY).
COBY is a Python-based software for building flat membranes in coarse-grained resolution. It handles asymmetric membranes, phase-separated systems, multiple bilayers, protein insertion, solvation and flooding with one or multiple solute molecules of choice.
COBY is versatile, fast, easy-to-use and it also allows for high-level of customisation. It can be used either as a **Python package** or directly from the **terminal command line**. It neatly handles multiple parameter libraries (even within the same system), making it developer-friendly.
COBY is continuously under development and we welcome suggestions for new features.
## Citation (bioRxiv)
```
@article {Andreasen2024COBY,
author = {Andreasen, Mikkel D. and Souza, Paulo C. T. and Schi{\o}tt, Birgit and Zuzic, Lorena},
title = {Creating Coarse-Grained Systems with COBY: Towards Higher Accuracy in Membrane Complexity},
elocation-id = {2024.07.23.604601},
year = {2024},
doi = {10.1101/2024.07.23.604601},
publisher = {Cold Spring Harbor Laboratory},
URL = {https://www.biorxiv.org/content/early/2024/07/23/2024.07.23.604601},
eprint = {https://www.biorxiv.org/content/early/2024/07/23/2024.07.23.604601.full.pdf},
journal = {bioRxiv}
}
```
## Installation
**Using pip (requires python>=3.9)**
conda create --name COBY python==3.9 ipykernel
conda activate COBY
pip install COBY
python -m ipykernel install --user --name=COBY
Ipykernel allows the user to use COBY environment within the Jupyter notebook.
## Basic usage
For a detailed introduction to the software, please consult [COBY Documentation](https://github.com/MikkelDA/COBY/blob/master/COBY_Documentation.pdf).
For a quick reminder of available commands, you can use the [Cheat Sheet](https://github.com/MikkelDA/COBY/blob/master/COBY_CHEAT_SHEET.pdf).
Three [tutorials](https://github.com/MikkelDA/COBY/tree/master/Tutorial) are available as Jupyter Notebooks, one covering the basics, another covering more advanced functionalities and the final covering the systems shown in our soon-to-be released paper.
The tutorials includes (amongst other systems):
* **Simple membrane with protein**: A simple POPC membrane with a protein in solvent (water + 0.15 M NaCl) which explains the various arguments in COBY
* **Asymmetric membrane**: An asymmetric complex membrane (POPC, POPE and CHOL) in solvent with different area per lipid values for each membrane
* **Phase separated Membrane**: A phase separated membrane
* **Monolayers**: Two monolayers with solvent between them and vacuum over the pbc
* **Nanodisc**: A nanodisc with DMPC lipid contained within and with solvent surrounding it
* **Holes**: A membrane with multiple manually defined holes
* **Patches**: Multiple manually shaped membrane patches
* **Matryoshka membrane**: A matryoshka membrane with a protein in the center
* **Stacked membranes**: Three vertically stacked membranes
* **Mixed solvent**: A symmetric membrane solvated with regular and small water beads in specified ratios
* **Phase separated solvent**: A symmetric membrane solvated with two solvent volumes containing different salt concentrations
* **Flooding of imported solutes**: A membrane system that has been flooded with imported solute molecules, followed by solvation
* **COBY logo**: Our logo
## Licence
COBY is preserved under the [Apache License 2.0](https://github.com/MikkelDA/COBY/blob/main/LICENSE).
Raw data
{
"_id": null,
"home_page": null,
"name": "COBY",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "building, dynamics, martini, molecular, system",
"author": null,
"author_email": "\"Andreasen, M.D.\" <mdahlandreasen@hotmail.com>",
"download_url": "https://files.pythonhosted.org/packages/7e/ab/1904299d81a07d63245fa89adde03e55b19f471c9b9495f0bef3c8382cfc/coby-0.2.3.tar.gz",
"platform": null,
"description": "# Coarse-grained System Builder (COBY)\n\nThe paper is currently in pre-print at [bioRxiv](https://www.biorxiv.org/content/10.1101/2024.07.23.604601v1).\n\nThe program as well as documentation and a tutorial is avialable on the [GitHub](https://github.com/MikkelDA/COBY).\n\nCOBY is a Python-based software for building flat membranes in coarse-grained resolution. It handles asymmetric membranes, phase-separated systems, multiple bilayers, protein insertion, solvation and flooding with one or multiple solute molecules of choice.\n\nCOBY is versatile, fast, easy-to-use and it also allows for high-level of customisation. It can be used either as a **Python package** or directly from the **terminal command line**. It neatly handles multiple parameter libraries (even within the same system), making it developer-friendly. \n\nCOBY is continuously under development and we welcome suggestions for new features. \n\n\n\n## Citation (bioRxiv)\n```\n@article {Andreasen2024COBY,\n\tauthor = {Andreasen, Mikkel D. and Souza, Paulo C. T. and Schi{\\o}tt, Birgit and Zuzic, Lorena},\n\ttitle = {Creating Coarse-Grained Systems with COBY: Towards Higher Accuracy in Membrane Complexity},\n\telocation-id = {2024.07.23.604601},\n\tyear = {2024},\n\tdoi = {10.1101/2024.07.23.604601},\n\tpublisher = {Cold Spring Harbor Laboratory},\n\tURL = {https://www.biorxiv.org/content/early/2024/07/23/2024.07.23.604601},\n\teprint = {https://www.biorxiv.org/content/early/2024/07/23/2024.07.23.604601.full.pdf},\n\tjournal = {bioRxiv}\n}\n```\n\n## Installation \n\n**Using pip (requires python>=3.9)**\n\n conda create --name COBY python==3.9 ipykernel\n\n conda activate COBY\n\n pip install COBY\n\n python -m ipykernel install --user --name=COBY\n\nIpykernel allows the user to use COBY environment within the Jupyter notebook.\n\n## Basic usage \n\nFor a detailed introduction to the software, please consult [COBY Documentation](https://github.com/MikkelDA/COBY/blob/master/COBY_Documentation.pdf).\n\nFor a quick reminder of available commands, you can use the [Cheat Sheet](https://github.com/MikkelDA/COBY/blob/master/COBY_CHEAT_SHEET.pdf).\n\nThree [tutorials](https://github.com/MikkelDA/COBY/tree/master/Tutorial) are available as Jupyter Notebooks, one covering the basics, another covering more advanced functionalities and the final covering the systems shown in our soon-to-be released paper.\n\nThe tutorials includes (amongst other systems):\n\n* **Simple membrane with protein**: A simple POPC membrane with a protein in solvent (water + 0.15 M NaCl) which explains the various arguments in COBY\n* **Asymmetric membrane**: An asymmetric complex membrane (POPC, POPE and CHOL) in solvent with different area per lipid values for each membrane\n* **Phase separated Membrane**: A phase separated membrane\n* **Monolayers**: Two monolayers with solvent between them and vacuum over the pbc\n* **Nanodisc**: A nanodisc with DMPC lipid contained within and with solvent surrounding it\n* **Holes**: A membrane with multiple manually defined holes\n* **Patches**: Multiple manually shaped membrane patches\n* **Matryoshka membrane**: A matryoshka membrane with a protein in the center\n* **Stacked membranes**: Three vertically stacked membranes\n* **Mixed solvent**: A symmetric membrane solvated with regular and small water beads in specified ratios\n* **Phase separated solvent**: A symmetric membrane solvated with two solvent volumes containing different salt concentrations\n* **Flooding of imported solutes**: A membrane system that has been flooded with imported solute molecules, followed by solvation\n* **COBY logo**: Our logo\n\n## Licence\n\nCOBY is preserved under the [Apache License 2.0](https://github.com/MikkelDA/COBY/blob/main/LICENSE).\n\n\n\n",
"bugtrack_url": null,
"license": null,
"summary": "Build coarse-grained molecular systems",
"version": "0.2.3",
"project_urls": {
"Repository": "https://github.com/MikkelDA/COBY"
},
"split_keywords": [
"building",
" dynamics",
" martini",
" molecular",
" system"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "8e77b23833a24dfca7fc408e0a58ca0090f76d35284fbfa77fbc295d95d41405",
"md5": "305a0db9f39e165c47a5acef1f71f4f9",
"sha256": "ab0a76027d938cf5a79e9de9ed233c9a72d4f034fbd28c620fc91ef4474d5ed4"
},
"downloads": -1,
"filename": "coby-0.2.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "305a0db9f39e165c47a5acef1f71f4f9",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 185787,
"upload_time": "2024-12-12T08:58:50",
"upload_time_iso_8601": "2024-12-12T08:58:50.415874Z",
"url": "https://files.pythonhosted.org/packages/8e/77/b23833a24dfca7fc408e0a58ca0090f76d35284fbfa77fbc295d95d41405/coby-0.2.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "7eab1904299d81a07d63245fa89adde03e55b19f471c9b9495f0bef3c8382cfc",
"md5": "c57bf59cd4b31ea6f586360d6f715e0d",
"sha256": "c45aaf215a0d240967727fab4d2c40989b326885f8ea32a572b27c0e71bba9e0"
},
"downloads": -1,
"filename": "coby-0.2.3.tar.gz",
"has_sig": false,
"md5_digest": "c57bf59cd4b31ea6f586360d6f715e0d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 133750,
"upload_time": "2024-12-12T08:58:52",
"upload_time_iso_8601": "2024-12-12T08:58:52.106573Z",
"url": "https://files.pythonhosted.org/packages/7e/ab/1904299d81a07d63245fa89adde03e55b19f471c9b9495f0bef3c8382cfc/coby-0.2.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-12 08:58:52",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "MikkelDA",
"github_project": "COBY",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "coby"
}
