mdapackmol


Namemdapackmol JSON
Version 0.1.0 PyPI version JSON
download
home_pagehttps://github.com/richardjgowers/mdapackmol
SummaryAn MDAnalysis wrapper around Packmol
upload_time2023-06-02 19:28:29
maintainer
docs_urlNone
authorRichard J Gowers
requires_python
licenseGNU General Public License v3
keywords mdapackmol
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            ==========
MDAPackmol
==========

.. |travis| image:: https://travis-ci.com/MDAnalysis/MDAPackmol.svg?branch=master
    :target: https://travis-ci.com/MDAnalysis/MDAPackmol 
.. |coveralls| image:: https://coveralls.io/repos/github/MDAnalysis/MDAPackmol/badge.svg?branch=master
    :target: https://coveralls.io/github/MDAnalysis/MDAPackmol?

|travis| |coveralls|

-----

## Why this fork?

MDAPackmol-fmt is a fork of the original MDAPackmol code adapted to the FillMyTubes code. 

## MDAPackmol

An MDAnalysis_ wrapper around Packmol_

* Allows combining MDAnalysis and Packmol

* Preserves the topology information (bonds etc) of your system after Packmol

* Free software: GNU General Public License v3

.. _MDAnalysis: https://www.mdanalysis.org
.. _Packmol: http://m3g.iqm.unicamp.br/packmol/home.shtml

Usage Example
-------------

.. code-block:: python

   import MDAnalysis as mda
   import mdapackmol
   
   # load individual molecule files
   water = mda.Universe('water.pdb')
   urea = mda.Universe('urea.pdb')
   
   # call Packmol with MDAnalysis objects as arguments
   # the 'instructions' allow for any valid Packmol commands
   system = mdapackmol.packmol(
       [mdapackmol.PackmolStructure(
           water, number=1000,
           instructions=['inside box 0. 0. 0. 40. 40. 40.']),
        mdapackmol.PackmolStructure(
           urea, number=400,
           instructions=['inside box 0. 0. 0. 40. 40. 40.'])]
   )
   
   # the returned system is a MDAnalysis Universe
   # with all topology information from building blocks retained
   # which can then be saved into any format
   # eg to Lammps data file:
   system.atoms.write('topology.data')


Citing
------

If you find mdapackmol useful for you, please cite the following sources:

 * L Martinez, R Andrade, E G Birgin, J M Martinez, "Packmol: A package for building initial configurations for molecular dynamics simulations". Journal of Computational Chemistry, 30, 2157-2164, 2009. 
 
 * R J Gowers, M Linke, J Barnoud, T J E Reddy, M N Melo, S L Seyler, D L Dotson, J Domanski, S Buchoux, I M Kenney, and O Beckstein. "MDAnalysis: A Python package for the rapid analysis of molecular dynamics simulations." In S. Benthall and S. Rostrup, editors, Proceedings of the 15th Python in Science Conference, pages 102-109, Austin, TX, 2016.



            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/richardjgowers/mdapackmol",
    "name": "mdapackmol",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "mdapackmol",
    "author": "Richard J Gowers",
    "author_email": "richardjgowers@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/eb/e7/adf1475306ba998b2afc1c9414aaa60ecc8a65353ac78b789b2a7d9b4fd0/mdapackmol-0.1.0.tar.gz",
    "platform": null,
    "description": "==========\nMDAPackmol\n==========\n\n.. |travis| image:: https://travis-ci.com/MDAnalysis/MDAPackmol.svg?branch=master\n    :target: https://travis-ci.com/MDAnalysis/MDAPackmol \n.. |coveralls| image:: https://coveralls.io/repos/github/MDAnalysis/MDAPackmol/badge.svg?branch=master\n    :target: https://coveralls.io/github/MDAnalysis/MDAPackmol?\n\n|travis| |coveralls|\n\n-----\n\n## Why this fork?\n\nMDAPackmol-fmt is a fork of the original MDAPackmol code adapted to the FillMyTubes code. \n\n## MDAPackmol\n\nAn MDAnalysis_ wrapper around Packmol_\n\n* Allows combining MDAnalysis and Packmol\n\n* Preserves the topology information (bonds etc) of your system after Packmol\n\n* Free software: GNU General Public License v3\n\n.. _MDAnalysis: https://www.mdanalysis.org\n.. _Packmol: http://m3g.iqm.unicamp.br/packmol/home.shtml\n\nUsage Example\n-------------\n\n.. code-block:: python\n\n   import MDAnalysis as mda\n   import mdapackmol\n   \n   # load individual molecule files\n   water = mda.Universe('water.pdb')\n   urea = mda.Universe('urea.pdb')\n   \n   # call Packmol with MDAnalysis objects as arguments\n   # the 'instructions' allow for any valid Packmol commands\n   system = mdapackmol.packmol(\n       [mdapackmol.PackmolStructure(\n           water, number=1000,\n           instructions=['inside box 0. 0. 0. 40. 40. 40.']),\n        mdapackmol.PackmolStructure(\n           urea, number=400,\n           instructions=['inside box 0. 0. 0. 40. 40. 40.'])]\n   )\n   \n   # the returned system is a MDAnalysis Universe\n   # with all topology information from building blocks retained\n   # which can then be saved into any format\n   # eg to Lammps data file:\n   system.atoms.write('topology.data')\n\n\nCiting\n------\n\nIf you find mdapackmol useful for you, please cite the following sources:\n\n * L Martinez, R Andrade, E G Birgin, J M Martinez, \"Packmol: A package for building initial configurations for molecular dynamics simulations\". Journal of Computational Chemistry, 30, 2157-2164, 2009. \n \n * R J Gowers, M Linke, J Barnoud, T J E Reddy, M N Melo, S L Seyler, D L Dotson, J Domanski, S Buchoux, I M Kenney, and O Beckstein. \"MDAnalysis: A Python package for the rapid analysis of molecular dynamics simulations.\" In S. Benthall and S. Rostrup, editors, Proceedings of the 15th Python in Science Conference, pages 102-109, Austin, TX, 2016.\n\n\n",
    "bugtrack_url": null,
    "license": "GNU General Public License v3",
    "summary": "An MDAnalysis wrapper around Packmol",
    "version": "0.1.0",
    "project_urls": {
        "Homepage": "https://github.com/richardjgowers/mdapackmol"
    },
    "split_keywords": [
        "mdapackmol"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "b779b7b1738e1405289b037f544d9f280eb7d149bd4a95985e04faf29b727af0",
                "md5": "f2d65c39a780ce503b5cfcc1e0a88f50",
                "sha256": "3f0b34f8d0abc98717833e8a18a1f77474606cc22092186a67e1113363f85728"
            },
            "downloads": -1,
            "filename": "mdapackmol-0.1.0-py2.py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "f2d65c39a780ce503b5cfcc1e0a88f50",
            "packagetype": "bdist_wheel",
            "python_version": "py2.py3",
            "requires_python": null,
            "size": 7466,
            "upload_time": "2023-06-02T19:28:27",
            "upload_time_iso_8601": "2023-06-02T19:28:27.592418Z",
            "url": "https://files.pythonhosted.org/packages/b7/79/b7b1738e1405289b037f544d9f280eb7d149bd4a95985e04faf29b727af0/mdapackmol-0.1.0-py2.py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "ebe7adf1475306ba998b2afc1c9414aaa60ecc8a65353ac78b789b2a7d9b4fd0",
                "md5": "42633ef32e1eae023ac934e0d636b712",
                "sha256": "36bf7e86a8cd4a62debdda3a0f891cf2ce5de8633268a9b9ae663ae4fb0c0d00"
            },
            "downloads": -1,
            "filename": "mdapackmol-0.1.0.tar.gz",
            "has_sig": false,
            "md5_digest": "42633ef32e1eae023ac934e0d636b712",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 12655,
            "upload_time": "2023-06-02T19:28:29",
            "upload_time_iso_8601": "2023-06-02T19:28:29.816296Z",
            "url": "https://files.pythonhosted.org/packages/eb/e7/adf1475306ba998b2afc1c9414aaa60ecc8a65353ac78b789b2a7d9b4fd0/mdapackmol-0.1.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-06-02 19:28:29",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "richardjgowers",
    "github_project": "mdapackmol",
    "github_not_found": true,
    "lcname": "mdapackmol"
}
        
Elapsed time: 0.07233s