# Martinize2 and vermouth: The ultimate resolution transformation tools
[](https://github.com/marrink-lab/vermouth-martinize/actions)
[](https://codecov.io/gh/marrink-lab/vermouth-martinize)
[](https://vermouth-martinize.readthedocs.io/en/latest/?badge=latest)
[](https://doi.org/10.5281/zenodo.7361701)
[](http://arxiv.org/abs/2212.01191)
Martinize2 is a rewrite of [Martinize]. It is aimed at producing
coarse-grained structures and topologies from an atomistic structure. Martinize
is primarily developed for the [Martini] coarse-grained force field and the
[Gromacs] simulation engine. However the architecture of the program will
allow us to support a broader range of force fields and simulation engines in
the future.
Vermouth (for VERsatile, MOdular, and Universal Tranformation Helper) is the
python library that powers Martinize2. It allows to describe and apply
transformation on molecular structures and topologies using graph algorithms.
## Disclaimer
Martinize2 and Vermouth are under development. So far they have mostly been
tested on Martini 2 and Martini 3. If you use Martinize 2 and Vermouth for any
other force field be sure to carefully check the resulting topologies!
Bugs can occur. If you encounter an issue, please report it on
<https://github.com/marrink-lab/vermouth-martinize/issues>. Carefully check your
input and output files before using them; read the messages displayed by the
program.
## Installation
Martinize2 and vermouth require python 3.6 or greater. They are distributed via [PyPi][pypi_vermouth], and can be
installed using the `pip` command:
pip install vermouth
This installs the last released version. You can update an existing installation by running `pip install -U vermouth`.
In some cases you may want to experiment with running the latest development version. You can install this version with
the following command:
pip install git+https://github.com/marrink-lab/vermouth-martinize.git#vermouth
Note that vermouth and Martinize2, in particular development versions, may contain bugs that cause it to produce
incorrect topologies. Check the produced output carefully!
Martinize2 and vermouth have [mdtraj][mdtraj] as optional dependency as an
alternative to dssp.
The behavior of the `pip` command can vary depending of the specificity of your
python installation. See the [documentation on installing a python
package][pipdoc] to learn more.
## Basic usage
Installing Martinize2 and vermouth with `pip` adds the `martinize2` program to
the research PATH. You can see the available option of the program by running:
martinize2 -h
At the moment, martinize2 tries to reproduce the interface of the original
Martinize. You can find explanations on how to use Martinize on the [Martini
tutorials]; in most cases, replacing calls to `martinize.py` by calls to
`martinize2` should produce similar results.
The documentation of the vermouth python library will come soon.
## Citation
```
@article{kroon2022martinize2,
title={Martinize2 and Vermouth: Unified Framework for Topology Generation},
author={Kroon, Peter C and Gr{\"u}newald, Fabian and Barnoud, Jonathan and van Tilburg, Marco
and Souza, Paulo CT and Wassenaar, Tsjerk A and Marrink, Siewert-Jan},
journal={arXiv preprint arXiv:2212.01191},
year={2022}}
```
## Documentation
More complete documentation, including API documentation can be found at
https://vermouth-martinize.readthedocs.io/
## License
Martinize2 and vermouth are distributed under the Apache 2.0 license.
Copyright 2018 University of Groningen
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
The [full text of the license][license] is available in the source repository.
## Contributions
The development of Martinize2 and vermouth is done on [github]. Contributions
are welcome as [bug reports] and [pull requests]. Note however that the
decision of whether or not contributions can give authorship on the resulting
academic paper is left to our sole discretion.
[Martinize]: https://github.com/Tsjerk/Martinize
[Martini]: http://cgmartini.nl
[Martini tutorials]: http://cgmartini.nl/index.php/tutorials-general-introduction-gmx5
[Gromacs]: http://www.gromacs.org
[pypi_vermouth]: https://pypi.org/project/vermouth/
[mdtraj]: https://www.mdtraj.org/
[pipdoc]: https://packaging.python.org/tutorials/installing-packages/#installing-packages
[license]: https://github.com/marrink-lab/vermouth-martinize/blob/master/LICENSE
[github]: https://github.com/marrink-lab/vermouth-martinize
[bug reports]: https://github.com/marrink-lab/vermouth-martinize/issues
[pull requests]: https://github.com/marrink-lab/vermouth-martinize/pulls
Raw data
{
"_id": null,
"home_page": "https://github.com/marrink-lab/vermouth-martinize",
"name": "vermouth",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "martini MD martinize",
"author": "P C Kroon",
"author_email": "p.c.kroon@rug.nl",
"download_url": "https://files.pythonhosted.org/packages/da/68/d4874bc897f086fd866e97e23911cac2504b47e99a35f907b2b2d127b38f/vermouth-0.12.0.tar.gz",
"platform": null,
"description": "# Martinize2 and vermouth: The ultimate resolution transformation tools\n\n[](https://github.com/marrink-lab/vermouth-martinize/actions)\n[](https://codecov.io/gh/marrink-lab/vermouth-martinize)\n[](https://vermouth-martinize.readthedocs.io/en/latest/?badge=latest)\n[](https://doi.org/10.5281/zenodo.7361701)\n[](http://arxiv.org/abs/2212.01191)\n\nMartinize2 is a rewrite of [Martinize]. It is aimed at producing\ncoarse-grained structures and topologies from an atomistic structure. Martinize\nis primarily developed for the [Martini] coarse-grained force field and the\n[Gromacs] simulation engine. However the architecture of the program will\nallow us to support a broader range of force fields and simulation engines in\nthe future.\n\nVermouth (for VERsatile, MOdular, and Universal Tranformation Helper) is the\npython library that powers Martinize2. It allows to describe and apply\ntransformation on molecular structures and topologies using graph algorithms.\n\n## Disclaimer\n\nMartinize2 and Vermouth are under development. So far they have mostly been\ntested on Martini 2 and Martini 3. If you use Martinize 2 and Vermouth for any\nother force field be sure to carefully check the resulting topologies! \nBugs can occur. If you encounter an issue, please report it on\n<https://github.com/marrink-lab/vermouth-martinize/issues>. Carefully check your\n input and output files before using them; read the messages displayed by the\n program.\n\n## Installation\n\nMartinize2 and vermouth require python 3.6 or greater. They are distributed via [PyPi][pypi_vermouth], and can be\ninstalled using the `pip` command:\n \n pip install vermouth\n\nThis installs the last released version. You can update an existing installation by running `pip install -U vermouth`.\nIn some cases you may want to experiment with running the latest development version. You can install this version with\nthe following command: \n\n pip install git+https://github.com/marrink-lab/vermouth-martinize.git#vermouth\n\nNote that vermouth and Martinize2, in particular development versions, may contain bugs that cause it to produce\nincorrect topologies. Check the produced output carefully!\n\nMartinize2 and vermouth have [mdtraj][mdtraj] as optional dependency as an \nalternative to dssp.\n\nThe behavior of the `pip` command can vary depending of the specificity of your\npython installation. See the [documentation on installing a python\npackage][pipdoc] to learn more.\n\n## Basic usage\n\nInstalling Martinize2 and vermouth with `pip` adds the `martinize2` program to\nthe research PATH. You can see the available option of the program by running:\n\n martinize2 -h\n\nAt the moment, martinize2 tries to reproduce the interface of the original\nMartinize. You can find explanations on how to use Martinize on the [Martini\ntutorials]; in most cases, replacing calls to `martinize.py` by calls to\n`martinize2` should produce similar results.\n\nThe documentation of the vermouth python library will come soon.\n\n## Citation\n```\n@article{kroon2022martinize2,\n title={Martinize2 and Vermouth: Unified Framework for Topology Generation},\n author={Kroon, Peter C and Gr{\\\"u}newald, Fabian and Barnoud, Jonathan and van Tilburg, Marco \n and Souza, Paulo CT and Wassenaar, Tsjerk A and Marrink, Siewert-Jan},\n journal={arXiv preprint arXiv:2212.01191},\n year={2022}}\n```\n\n## Documentation\n\nMore complete documentation, including API documentation can be found at\nhttps://vermouth-martinize.readthedocs.io/\n\n## License\n\nMartinize2 and vermouth are distributed under the Apache 2.0 license.\n\n Copyright 2018 University of Groningen\n\n\tLicensed under the Apache License, Version 2.0 (the \"License\");\n\tyou may not use this file except in compliance with the License.\n\tYou may obtain a copy of the License at\n\n\t\thttp://www.apache.org/licenses/LICENSE-2.0\n\n\tUnless required by applicable law or agreed to in writing, software\n\tdistributed under the License is distributed on an \"AS IS\" BASIS,\n\tWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n\tSee the License for the specific language governing permissions and\n\tlimitations under the License.\n\nThe [full text of the license][license] is available in the source repository.\n\n## Contributions\n\nThe development of Martinize2 and vermouth is done on [github]. Contributions\nare welcome as [bug reports] and [pull requests]. Note however that the\ndecision of whether or not contributions can give authorship on the resulting\nacademic paper is left to our sole discretion.\n\n[Martinize]: https://github.com/Tsjerk/Martinize\n[Martini]: http://cgmartini.nl\n[Martini tutorials]: http://cgmartini.nl/index.php/tutorials-general-introduction-gmx5\n[Gromacs]: http://www.gromacs.org\n[pypi_vermouth]: https://pypi.org/project/vermouth/\n[mdtraj]: https://www.mdtraj.org/\n[pipdoc]: https://packaging.python.org/tutorials/installing-packages/#installing-packages\n[license]: https://github.com/marrink-lab/vermouth-martinize/blob/master/LICENSE\n[github]: https://github.com/marrink-lab/vermouth-martinize\n[bug reports]: https://github.com/marrink-lab/vermouth-martinize/issues\n[pull requests]: https://github.com/marrink-lab/vermouth-martinize/pulls\n\n",
"bugtrack_url": null,
"license": "Apache 2.0",
"summary": null,
"version": "0.12.0",
"project_urls": {
"Homepage": "https://github.com/marrink-lab/vermouth-martinize"
},
"split_keywords": [
"martini",
"md",
"martinize"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d0ad7fca5d9481351ea8b54f0c4e8df454de5c4cc14b0c99577d016088e8696f",
"md5": "acccf28835a48c4a82115a3a971120c3",
"sha256": "1cef3f246e877ca2a99e934fa9195b83f32655f8cf9650567c23db980d5173ca"
},
"downloads": -1,
"filename": "vermouth-0.12.0-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "acccf28835a48c4a82115a3a971120c3",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 3074596,
"upload_time": "2024-11-14T09:55:15",
"upload_time_iso_8601": "2024-11-14T09:55:15.487205Z",
"url": "https://files.pythonhosted.org/packages/d0/ad/7fca5d9481351ea8b54f0c4e8df454de5c4cc14b0c99577d016088e8696f/vermouth-0.12.0-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "da68d4874bc897f086fd866e97e23911cac2504b47e99a35f907b2b2d127b38f",
"md5": "32906797fd0ab7d19517237d8f4f90d3",
"sha256": "e1771b2852e8d3dd49b4d792a8277b1d6d44a31c14b7edbdf472558528a83653"
},
"downloads": -1,
"filename": "vermouth-0.12.0.tar.gz",
"has_sig": false,
"md5_digest": "32906797fd0ab7d19517237d8f4f90d3",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 2778590,
"upload_time": "2024-11-14T09:55:18",
"upload_time_iso_8601": "2024-11-14T09:55:18.643397Z",
"url": "https://files.pythonhosted.org/packages/da/68/d4874bc897f086fd866e97e23911cac2504b47e99a35f907b2b2d127b38f/vermouth-0.12.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-14 09:55:18",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "marrink-lab",
"github_project": "vermouth-martinize",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "vermouth"
}
JSON
