=====================
SEAMM Packmol Plug-in
=====================
.. image:: https://img.shields.io/github/issues-pr-raw/molssi-seamm/packmol_step
:target: https://github.com/molssi-seamm/packmol_step/pulls
:alt: GitHub pull requests
.. image:: https://github.com/molssi-seamm/packmol_step/workflows/CI/badge.svg
:target: https://github.com/molssi-seamm/packmol_step/actions
:alt: Build Status
.. image:: https://codecov.io/gh/molssi-seamm/packmol_step/branch/master/graph/badge.svg
:target: https://codecov.io/gh/molssi-seamm/packmol_step
:alt: Code Coverage
.. image:: https://github.com/molssi-seamm/packmol_step/workflows/CodeQL/badge.svg
:target: https://github.com/molssi-seamm/packmol_step/security/code-scanning
:alt: Code Quality
.. image:: https://github.com/molssi-seamm/packmol_step/workflows/Release/badge.svg
:target: https://molssi-seamm.github.io/packmol_step/index.html
:alt: Documentation Status
.. image:: https://img.shields.io/pypi/v/packmol_step.svg
:target: https://pypi.python.org/pypi/packmol_step
:alt: PyPi VERSION
A SEAMM plug-in for building periodic boxes of fluid using Packmol_
This plug-in takes the molecule in the current system and creates a
periodic box containing many copies of the molecule in order to
simulate a fluid.
* Free software: BSD license
* Documentation: https://molssi-seamm.github.io/packmol_step/index.html
* Code: https://github.com/molssi-seamm/packmol_step
.. _Packmol: http://m3g.iqm.unicamp.br/packmol/home.shtml
Features
--------
* Multiple ways to specify final cell:
- Size of the cubic cell *and* density *or* number of molecules *or*
number of atoms.
- Volume *and* density *or* number of molecules *or* number of atoms.
- density *and* size of the cubic cell *or* volume *or* number of
molecules *or* of atoms.
Acknowledgements
----------------
This package was created with Cookiecutter_ and the `molssi-seamm/cookiecutter-seamm-plugin`_ project template.
.. _Cookiecutter: https://github.com/audreyr/cookiecutter
.. _`molssi-seamm/cookiecutter-seamm-plugin`: https://github.com/molssi-seamm/cookiecutter-seamm-plugin
Developed by the Molecular Sciences Software Institute (MolSSI_),
which receives funding from the `National Science Foundation`_ under
awards OAC-1547580 and CHE-2136142
.. _MolSSI: https://www.molssi.org
.. _`National Science Foundation`: https://www.nsf.gov
=======
History
=======
2024.6.21.2 -- Another internal release for Docker.
2024.6.21.1 -- Internal release for Docker
* There was an internal issue creating the Docker image.
2024.6.21 -- Switching to RDKit for SMILES
* Using RDKit for SMILES since we found some issues with OpenBabel, and also the
atom typing uses RDKit, so this is more compatible.
2024.3.19 -- Updated installer for new scheme
* packmol-step-installer now uses the new scheme, which supports both Conda and
Docker installation.
* Added seamm-packmol Docker image
2024.1.16 -- Adding support for containers
* Added the ability to work in Docker containers.
2023.9.6 -- Using fractional coordinates for periodic systems.
* By convention, SEAMM is using fractional coordinates for periodic systems. The
PACKMOL step was creating periodic structures with Cartesian coordinates, which
can be a bit confusing, though it did not affect any reauls. This change fixes the
issue.
2023.2.15 -- Restructured documentation and moved to new theme.
2022.5.31 -- Substantial enhancements
Added ability to solvate molecules and increased the options to include
* spherical regions
* cubic and rectangular regions
* cubic and rectangular unit cells for periodic systems
* input molecules from any combination of system/configurations and SMILES
* reworked GUI to be more intuitive.
2021.11.27 -- Fixed bug with atom types.
2021.10.25 -- Bugfix for problems with ideal gas approach.
2021.8.29 -- Multiple different molecules available via SMILES
This release adds
* the ability to directly generate multiple different molecules from SMILES, giving
the stoichiometry for packing into the fluid box.
* specifying the desired cell with the temperature and pressure, along with one of
the volume, length of the box side, number of molecules or number of atoms. This
uses the ideal gas law, so will only be reasonable at higher temperatures and lower
densities.
Additionally, internally the release adds integration tests to check whether the module works properly in the SEAMM environment.
2021.6.3 -- internal change for improvements in parsing the commandline
2021.5.25 -- Added installer for Packmol executable.
2021.2.11 (11 February 2021)
----------------------------
* Updated the README file to give a better description.
* Updated the short description in setup.py to work with the new installer.
* Added keywords for better searchability.
2021.2.4 (4 February 2021)
--------------------------
* Updated for compatibility with the new system classes in MolSystem
2021.2.2 release.
2020.12.5 (5 December 2020)
---------------------------
* Internal: switching CI from TravisCI to GitHub Actions, and in the
process moving documentation from ReadTheDocs to GitHub Pages where
it is consolidated with the main SEAMM documentation.
2020.11.2 (2 November 2020)
---------------------------
* Updated to be compatible with the new command-line argument
handling.
2020.10.7 (7 October 2020)
----------------------------
* Added citations to be printed and stored.
2020.9.29 (29 September 2020)
-----------------------------
* Updated to be compatible with the new system classes in MolSystem.
2020.8.1 (1 August 2020)
------------------------
* Fixed bugs in the edit dialog.
0.9 (15 April 2020)
-------------------
* General bug fixing and code cleanup.
* Part of release of all modules.
0.7.0 (17 December 2019)
------------------------
* General clean-up of code and output.
* Part of release of all modules.
v0.3.0 (27 August 2019)
-----------------------
* First running version with reasonable output.
0.2.0 (13 August 2019)
----------------------
* First release on PyPI.
Raw data
{
"_id": null,
"home_page": "https://github.com/molssi-seam/packmol_step",
"name": "packmol-step",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "SEAMM, plug-in, flowchart, Packmol, fluid, molecules",
"author": "Paul Saxe",
"author_email": "psaxe@molssi.org",
"download_url": "https://files.pythonhosted.org/packages/33/ee/b2b1befbf2afad10306d7a9fc86a078ae32663b7be6e95bea9a65faa352a/packmol_step-2024.6.21.2.tar.gz",
"platform": "Linux",
"description": "=====================\nSEAMM Packmol Plug-in\n=====================\n\n.. image:: https://img.shields.io/github/issues-pr-raw/molssi-seamm/packmol_step\n :target: https://github.com/molssi-seamm/packmol_step/pulls\n :alt: GitHub pull requests\n\n.. image:: https://github.com/molssi-seamm/packmol_step/workflows/CI/badge.svg\n :target: https://github.com/molssi-seamm/packmol_step/actions\n :alt: Build Status\n\n.. image:: https://codecov.io/gh/molssi-seamm/packmol_step/branch/master/graph/badge.svg\n :target: https://codecov.io/gh/molssi-seamm/packmol_step\n :alt: Code Coverage\n\n.. image:: https://github.com/molssi-seamm/packmol_step/workflows/CodeQL/badge.svg\n :target: https://github.com/molssi-seamm/packmol_step/security/code-scanning\n :alt: Code Quality\n\n.. image:: https://github.com/molssi-seamm/packmol_step/workflows/Release/badge.svg\n :target: https://molssi-seamm.github.io/packmol_step/index.html\n :alt: Documentation Status\n\n.. image:: https://img.shields.io/pypi/v/packmol_step.svg\n :target: https://pypi.python.org/pypi/packmol_step\n :alt: PyPi VERSION\n\nA SEAMM plug-in for building periodic boxes of fluid using Packmol_\n\nThis plug-in takes the molecule in the current system and creates a\nperiodic box containing many copies of the molecule in order to\nsimulate a fluid.\n\n* Free software: BSD license\n* Documentation: https://molssi-seamm.github.io/packmol_step/index.html\n* Code: https://github.com/molssi-seamm/packmol_step\n\n.. _Packmol: http://m3g.iqm.unicamp.br/packmol/home.shtml\n\nFeatures\n--------\n\n* Multiple ways to specify final cell:\n\n - Size of the cubic cell *and* density *or* number of molecules *or*\n number of atoms.\n - Volume *and* density *or* number of molecules *or* number of atoms.\n - density *and* size of the cubic cell *or* volume *or* number of\n molecules *or* of atoms.\n\nAcknowledgements\n----------------\n\nThis package was created with Cookiecutter_ and the `molssi-seamm/cookiecutter-seamm-plugin`_ project template.\n\n.. _Cookiecutter: https://github.com/audreyr/cookiecutter\n.. _`molssi-seamm/cookiecutter-seamm-plugin`: https://github.com/molssi-seamm/cookiecutter-seamm-plugin\n\nDeveloped by the Molecular Sciences Software Institute (MolSSI_),\nwhich receives funding from the `National Science Foundation`_ under\nawards OAC-1547580 and CHE-2136142\n\n.. _MolSSI: https://www.molssi.org\n.. _`National Science Foundation`: https://www.nsf.gov\n\n\n=======\nHistory\n=======\n2024.6.21.2 -- Another internal release for Docker.\n\n2024.6.21.1 -- Internal release for Docker\n * There was an internal issue creating the Docker image.\n \n2024.6.21 -- Switching to RDKit for SMILES\n * Using RDKit for SMILES since we found some issues with OpenBabel, and also the\n atom typing uses RDKit, so this is more compatible.\n \n2024.3.19 -- Updated installer for new scheme\n * packmol-step-installer now uses the new scheme, which supports both Conda and\n Docker installation.\n * Added seamm-packmol Docker image\n\n2024.1.16 -- Adding support for containers\n * Added the ability to work in Docker containers.\n \n2023.9.6 -- Using fractional coordinates for periodic systems.\n * By convention, SEAMM is using fractional coordinates for periodic systems. The\n PACKMOL step was creating periodic structures with Cartesian coordinates, which\n can be a bit confusing, though it did not affect any reauls. This change fixes the\n issue. \n \n2023.2.15 -- Restructured documentation and moved to new theme.\n\n2022.5.31 -- Substantial enhancements\n Added ability to solvate molecules and increased the options to include\n\n * spherical regions\n * cubic and rectangular regions\n * cubic and rectangular unit cells for periodic systems\n * input molecules from any combination of system/configurations and SMILES\n * reworked GUI to be more intuitive.\n\n2021.11.27 -- Fixed bug with atom types.\n\n2021.10.25 -- Bugfix for problems with ideal gas approach.\n\n2021.8.29 -- Multiple different molecules available via SMILES\n This release adds\n\n * the ability to directly generate multiple different molecules from SMILES, giving\n the stoichiometry for packing into the fluid box.\n * specifying the desired cell with the temperature and pressure, along with one of\n the volume, length of the box side, number of molecules or number of atoms. This\n uses the ideal gas law, so will only be reasonable at higher temperatures and lower\n densities. \n\n Additionally, internally the release adds integration tests to check whether the module works properly in the SEAMM environment.\n\n2021.6.3 -- internal change for improvements in parsing the commandline\n\n2021.5.25 -- Added installer for Packmol executable.\n\n2021.2.11 (11 February 2021)\n----------------------------\n\n* Updated the README file to give a better description.\n* Updated the short description in setup.py to work with the new installer.\n* Added keywords for better searchability.\n\n2021.2.4 (4 February 2021)\n--------------------------\n\n* Updated for compatibility with the new system classes in MolSystem\n 2021.2.2 release.\n\n2020.12.5 (5 December 2020)\n---------------------------\n\n* Internal: switching CI from TravisCI to GitHub Actions, and in the\n process moving documentation from ReadTheDocs to GitHub Pages where\n it is consolidated with the main SEAMM documentation.\n\n2020.11.2 (2 November 2020)\n---------------------------\n\n* Updated to be compatible with the new command-line argument\n handling.\n\n2020.10.7 (7 October 2020)\n----------------------------\n\n* Added citations to be printed and stored.\n\n2020.9.29 (29 September 2020)\n-----------------------------\n\n* Updated to be compatible with the new system classes in MolSystem.\n\n2020.8.1 (1 August 2020)\n------------------------\n\n* Fixed bugs in the edit dialog.\n\n0.9 (15 April 2020)\n-------------------\n\n* General bug fixing and code cleanup.\n* Part of release of all modules.\n\n0.7.0 (17 December 2019)\n------------------------\n\n* General clean-up of code and output.\n* Part of release of all modules.\n\nv0.3.0 (27 August 2019)\n-----------------------\n\n* First running version with reasonable output.\n\n0.2.0 (13 August 2019)\n----------------------\n\n* First release on PyPI.\n",
"bugtrack_url": null,
"license": "BSD-3-Clause",
"summary": "A SEAMM plug-in for building periodic boxes of fluid using Packmol",
"version": "2024.6.21.2",
"project_urls": {
"Homepage": "https://github.com/molssi-seam/packmol_step"
},
"split_keywords": [
"seamm",
" plug-in",
" flowchart",
" packmol",
" fluid",
" molecules"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b5244f0b11d9f6f7a0480c3bba0e98a59dfd0cdf568186a37b8c241a5a981799",
"md5": "8bdf4def97484870202ffcc6683697a6",
"sha256": "211d078fae84ab9f061e062bb6a77a2c18142af3c02eeaaaf832039bd7c99562"
},
"downloads": -1,
"filename": "packmol_step-2024.6.21.2-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "8bdf4def97484870202ffcc6683697a6",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 24278,
"upload_time": "2024-06-21T15:08:39",
"upload_time_iso_8601": "2024-06-21T15:08:39.974318Z",
"url": "https://files.pythonhosted.org/packages/b5/24/4f0b11d9f6f7a0480c3bba0e98a59dfd0cdf568186a37b8c241a5a981799/packmol_step-2024.6.21.2-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "33eeb2b1befbf2afad10306d7a9fc86a078ae32663b7be6e95bea9a65faa352a",
"md5": "f5d4437700c214d109636c61aa54bd1e",
"sha256": "e5e4bd2dae19e7024095e7e7c106e94c4d448154e1a642c7815c4f247c0b7549"
},
"downloads": -1,
"filename": "packmol_step-2024.6.21.2.tar.gz",
"has_sig": false,
"md5_digest": "f5d4437700c214d109636c61aa54bd1e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 320203,
"upload_time": "2024-06-21T15:08:41",
"upload_time_iso_8601": "2024-06-21T15:08:41.883335Z",
"url": "https://files.pythonhosted.org/packages/33/ee/b2b1befbf2afad10306d7a9fc86a078ae32663b7be6e95bea9a65faa352a/packmol_step-2024.6.21.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-06-21 15:08:41",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "molssi-seam",
"github_project": "packmol_step",
"github_not_found": true,
"lcname": "packmol-step"
}
JSON
