.. image:: https://img.shields.io/github/issues-pr-raw/molssi-seamm/forcefield_step
:target: https://github.com/molssi-seamm/forcefield_step/pulls
:alt: GitHub pull requests
.. image:: https://github.com/molssi-seamm/forcefield_step/workflows/CI/badge.svg
:target: https://github.com/molssi-seamm/forcefield_step/actions
:alt: Build Status
.. image:: https://codecov.io/gh/molssi-seamm/forcefield_step/branch/master/graph/badge.svg
:target: https://codecov.io/gh/molssi-seamm/forcefield_step
:alt: Code Coverage
.. image:: https://github.com/molssi-seamm/forcefield_step/workflows/CodeQL/badge.svg
:target: https://github.com/molssi-seamm/forcefield_step/security/code-scanning
:alt: Code Quality
.. image:: https://github.com/molssi-seamm/forcefield_step/workflows/Release/badge.svg
:target: https://molssi-seamm.github.io/forcefield_step/index.html
:alt: Documentation Status
.. image:: https://img.shields.io/pypi/v/forcefield_step.svg
:target: https://pypi.python.org/pypi/forcefield_step
:alt: PyPi VERSION
========================
SEAMM Forcefield Plug-in
========================
A SEAMM plug-in for setting up a forcefield or EAM potentials for
subsequent simulations.
This plug-in provides a graphical user interface (GUI) for choosing
the forcefield or EAM potentials use by subsequent simulation steps.
* Free software: BSD license
* Documentation: https://molssi-seamm.github.io/forcefield_step/index.html
Features
--------
* Support for PCFF class II forcefield.
* Support for OpenKIM and the potentials it supports.
* For OpenKIM potentials choice is managed through a periodic table
interface, making it simple to find the right potentials.
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
award ACI-1547580
.. _MolSSI: https://www.molssi.org
.. _`National Science Foundation`: https://www.nsf.gov
=======
History
=======
2024.6.30 -- Bugfix: Error submitting jobs with local forcefield files.
2024.6.29 -- Bugfix: factor of 2 for dihedrals and impropers in ligpargen
* The ligpargen tool was missing a factor of 2 in the dihedral and improper parameters.
* Corrected the search paths for forcefields.
* Improved the documentation.
2024.6.28 -- Added customizable local forcefields and LigParGen interface.
* Added the machinery to handle local forcefield files in either
~/.seamm.d/data/Forcefields (personal) or ~/SEAMM/data/Forcefields (site).
* Added 'ligpargen' command to access custom parameters from the LigParGen service
at Yale University, ading them to the 'ligpargen.frc' personal forcefield, which
is automatically included in 'oplsaa.frc' if it exists.
2024.1.10 -- Fixed PF6- issue in CL&P forcefield
* The angle parameters for PF6- in the CL&P forcefield only work if the 180º F-P-F
angles are not included in the calculation. Replacing them with an equivalent
periodic SHAPES-like potential almost works; however, since 0º is a valid angle and
there are no 1-3 nonbonds, nothing keeps the F atoms apart. This is solved using a
tabulated potential based on the SHAPES potential but with an added 1-3 repulsion
large enough that the gradient is always pusing small angles apart, but not large
enough to affect the minimum at 90º.
2023.9.14 -- Fixed errors! And added C2mim to test.
* The units of the torsions were incorrect in the last implementation.
* Added parameters for 1-alkyl-3-methylimidazolium cations from JCP 108, 2038 (2004)
* Tested much more thoroughly.
2023.9.13 -- Added parameters for TFSI to CL&P/OPLSAA
* Parameters for TFSI - bis[(trifluoromethyl)sulfonyl]imide
2023.9.8 -- Added more typing for OPLS-AA
* cyclopropane -CH2-, -CHR-, and -CR2-
* hexafluorobenzene
* difluorobenzene
* bromobenzene
* iodobenzene
* thiophenol
* alkyl nitriles
* nitroalkanes
* nitrobenzene
* methylene in phenylacetonitrile
* corrections to methylene nitrile anion
2023.9.7 -- Added typing in OPLS_AA for fluorobenzene
2023.9.6 -- Fixed issue with PF6- geometry
* The Lennard-Jones repulsive term added to the F-P-F angle was too weak, allowing the
structure to get trapped in a symmetric state with ~40º angles.
2023.8.27 -- Fixed issue with angle in octahedral systems
* The SHAPES-type simple fourier potential used for octahedral complexes has a fals
minimim at 0º. Added a LJ 1/R^12 repulsive term between the two end atoms of the
angle to prevent small angles. This required using tabulated potentials in LAMMPS.
2023.5.1 -- Fixed bug in Lithium battery forcefield
* Fixed a typo in the angle type unit line which caused a crash
2023.4.6 -- Added Lithium battery forcefield
* An initial set of parameters for cathode materials, specifically LiCoO2.
2023.2.13 -- Added OPLS-AA forcefield
* Added parameters for OPLS-AA along with some extra parameters for ionic liquids
* PF6-
* ethylene carbonate (EC) and fluoronated EC (FEC)
* Added atom-typing templates for most of OPLS-AA. Still missing a few and amino
acids and DNA not yet tested.
* Added extensive, almost-complete testing, for OPLS-AA
2021.2.10 (10 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.
2020.8.1 (1 August 2020)
------------------------
* Added support for OpenKIM potentials in LAMMPS
0.9.1 (24 May 2020)
-------------------
* Added the specialized NaCl_water forcefield for testing the MolSSI
Driver Interface (MDI) metadynamics driver.
0.9 (15 April 2020)
-------------------
* Internal changes for compatibility
0.1.0 (24 December 2017)
------------------------
* First release on PyPI.
Raw data
{
"_id": null,
"home_page": "https://github.com/molssi-seam/forcefield_step",
"name": "forcefield-step",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "SEAMM, plug-in, flowchart, forcefield, EAM, OpenKIM",
"author": "Paul Saxe",
"author_email": "psaxe@molssi.org",
"download_url": "https://files.pythonhosted.org/packages/16/9b/1f1912026c01708b46e0202a7f21b039d3bbd4470249d9fa9b8bcbe2dc9e/forcefield_step-2024.6.30.tar.gz",
"platform": "Linux",
"description": ".. image:: https://img.shields.io/github/issues-pr-raw/molssi-seamm/forcefield_step\n :target: https://github.com/molssi-seamm/forcefield_step/pulls\n :alt: GitHub pull requests\n\n.. image:: https://github.com/molssi-seamm/forcefield_step/workflows/CI/badge.svg\n :target: https://github.com/molssi-seamm/forcefield_step/actions\n :alt: Build Status\n\n.. image:: https://codecov.io/gh/molssi-seamm/forcefield_step/branch/master/graph/badge.svg\n :target: https://codecov.io/gh/molssi-seamm/forcefield_step\n :alt: Code Coverage\n\n.. image:: https://github.com/molssi-seamm/forcefield_step/workflows/CodeQL/badge.svg\n :target: https://github.com/molssi-seamm/forcefield_step/security/code-scanning\n :alt: Code Quality\n\n.. image:: https://github.com/molssi-seamm/forcefield_step/workflows/Release/badge.svg\n :target: https://molssi-seamm.github.io/forcefield_step/index.html\n :alt: Documentation Status\n\n.. image:: https://img.shields.io/pypi/v/forcefield_step.svg\n :target: https://pypi.python.org/pypi/forcefield_step\n :alt: PyPi VERSION\n\n========================\nSEAMM Forcefield Plug-in\n========================\n\nA SEAMM plug-in for setting up a forcefield or EAM potentials for\nsubsequent simulations.\n\nThis plug-in provides a graphical user interface (GUI) for choosing\nthe forcefield or EAM potentials use by subsequent simulation steps.\n\n* Free software: BSD license\n* Documentation: https://molssi-seamm.github.io/forcefield_step/index.html\n\nFeatures\n--------\n\n* Support for PCFF class II forcefield.\n* Support for OpenKIM and the potentials it supports.\n* For OpenKIM potentials choice is managed through a periodic table\n interface, making it simple to find the right potentials.\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\naward ACI-1547580\n\n.. _MolSSI: https://www.molssi.org\n.. _`National Science Foundation`: https://www.nsf.gov\n\n\n=======\nHistory\n=======\n2024.6.30 -- Bugfix: Error submitting jobs with local forcefield files.\n\n2024.6.29 -- Bugfix: factor of 2 for dihedrals and impropers in ligpargen\n * The ligpargen tool was missing a factor of 2 in the dihedral and improper parameters.\n * Corrected the search paths for forcefields.\n * Improved the documentation.\n \n2024.6.28 -- Added customizable local forcefields and LigParGen interface.\n * Added the machinery to handle local forcefield files in either\n ~/.seamm.d/data/Forcefields (personal) or ~/SEAMM/data/Forcefields (site).\n * Added 'ligpargen' command to access custom parameters from the LigParGen service\n at Yale University, ading them to the 'ligpargen.frc' personal forcefield, which\n is automatically included in 'oplsaa.frc' if it exists.\n\n2024.1.10 -- Fixed PF6- issue in CL&P forcefield\n * The angle parameters for PF6- in the CL&P forcefield only work if the 180\u00ba F-P-F\n angles are not included in the calculation. Replacing them with an equivalent\n periodic SHAPES-like potential almost works; however, since 0\u00ba is a valid angle and\n there are no 1-3 nonbonds, nothing keeps the F atoms apart. This is solved using a\n tabulated potential based on the SHAPES potential but with an added 1-3 repulsion\n large enough that the gradient is always pusing small angles apart, but not large\n enough to affect the minimum at 90\u00ba.\n\n2023.9.14 -- Fixed errors! And added C2mim to test.\n * The units of the torsions were incorrect in the last implementation.\n * Added parameters for 1-alkyl-3-methylimidazolium cations from JCP 108, 2038 (2004)\n * Tested much more thoroughly.\n\n2023.9.13 -- Added parameters for TFSI to CL&P/OPLSAA\n * Parameters for TFSI - bis[(trifluoromethyl)sulfonyl]imide\n\n2023.9.8 -- Added more typing for OPLS-AA\n * cyclopropane -CH2-, -CHR-, and -CR2-\n * hexafluorobenzene\n * difluorobenzene\n * bromobenzene\n * iodobenzene\n * thiophenol\n * alkyl nitriles\n * nitroalkanes\n * nitrobenzene\n * methylene in phenylacetonitrile\n * corrections to methylene nitrile anion\n\n2023.9.7 -- Added typing in OPLS_AA for fluorobenzene\n\n2023.9.6 -- Fixed issue with PF6- geometry\n * The Lennard-Jones repulsive term added to the F-P-F angle was too weak, allowing the\n structure to get trapped in a symmetric state with ~40\u00ba angles.\n\n2023.8.27 -- Fixed issue with angle in octahedral systems\n * The SHAPES-type simple fourier potential used for octahedral complexes has a fals\n minimim at 0\u00ba. Added a LJ 1/R^12 repulsive term between the two end atoms of the\n angle to prevent small angles. This required using tabulated potentials in LAMMPS.\n \n2023.5.1 -- Fixed bug in Lithium battery forcefield\n * Fixed a typo in the angle type unit line which caused a crash\n \n2023.4.6 -- Added Lithium battery forcefield\n * An initial set of parameters for cathode materials, specifically LiCoO2.\n\n2023.2.13 -- Added OPLS-AA forcefield\n * Added parameters for OPLS-AA along with some extra parameters for ionic liquids\n * PF6-\n * ethylene carbonate (EC) and fluoronated EC (FEC)\n * Added atom-typing templates for most of OPLS-AA. Still missing a few and amino\n acids and DNA not yet tested.\n * Added extensive, almost-complete testing, for OPLS-AA\n \n\n2021.2.10 (10 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\n2020.8.1 (1 August 2020)\n------------------------\n\n* Added support for OpenKIM potentials in LAMMPS\n\n0.9.1 (24 May 2020)\n-------------------\n\n* Added the specialized NaCl_water forcefield for testing the MolSSI\n Driver Interface (MDI) metadynamics driver.\n\n0.9 (15 April 2020)\n-------------------\n\n* Internal changes for compatibility\n \n0.1.0 (24 December 2017)\n------------------------\n\n* First release on PyPI.\n",
"bugtrack_url": null,
"license": "BSD-3-Clause",
"summary": "A SEAMM plug-in for setting up a forcefield or EAM potentials for subsequent simulations.",
"version": "2024.6.30",
"project_urls": {
"Homepage": "https://github.com/molssi-seam/forcefield_step"
},
"split_keywords": [
"seamm",
" plug-in",
" flowchart",
" forcefield",
" eam",
" openkim"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "5a3ea4a9d9bdf90c896d94d264a266be88983128aff380dfd79c25f84926c4e8",
"md5": "cf1fa7ed47922367510a55a60e922131",
"sha256": "246c11e889830e2282575b47f7eb9758a9eb1a93166e2b92da44cdaf118f8851"
},
"downloads": -1,
"filename": "forcefield_step-2024.6.30-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "cf1fa7ed47922367510a55a60e922131",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 136035,
"upload_time": "2024-06-30T19:34:04",
"upload_time_iso_8601": "2024-06-30T19:34:04.154858Z",
"url": "https://files.pythonhosted.org/packages/5a/3e/a4a9d9bdf90c896d94d264a266be88983128aff380dfd79c25f84926c4e8/forcefield_step-2024.6.30-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "169b1f1912026c01708b46e0202a7f21b039d3bbd4470249d9fa9b8bcbe2dc9e",
"md5": "b64236e603f35cb03e0c0fe8fc987d67",
"sha256": "a7954f9e8b17811e907ec812cdcef6b9bd8be300bc064f92bb90d8cd3af9445b"
},
"downloads": -1,
"filename": "forcefield_step-2024.6.30.tar.gz",
"has_sig": false,
"md5_digest": "b64236e603f35cb03e0c0fe8fc987d67",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 1761128,
"upload_time": "2024-06-30T19:34:06",
"upload_time_iso_8601": "2024-06-30T19:34:06.180201Z",
"url": "https://files.pythonhosted.org/packages/16/9b/1f1912026c01708b46e0202a7f21b039d3bbd4470249d9fa9b8bcbe2dc9e/forcefield_step-2024.6.30.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-06-30 19:34:06",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "molssi-seam",
"github_project": "forcefield_step",
"github_not_found": true,
"lcname": "forcefield-step"
}