forcefield-step


Nameforcefield-step JSON
Version 2024.1.10 PyPI version JSON
download
home_pagehttps://github.com/molssi-seam/forcefield_step
SummaryA SEAMM plug-in for setting up a forcefield or EAM potentials for subsequent simulations.
upload_time2024-01-10 16:16:11
maintainer
docs_urlNone
authorPaul Saxe
requires_python
licenseBSD-3-Clause
keywords seamm plug-in flowchart forcefield eam openkim
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            .. 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.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": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "SEAMM,plug-in,flowchart,forcefield,EAM,OpenKIM",
    "author": "Paul Saxe",
    "author_email": "psaxe@molssi.org",
    "download_url": "https://files.pythonhosted.org/packages/63/ea/ce46a359af739656d473e4386e9f94156e450c2c014f6d4121f4769aef2d/forcefield_step-2024.1.10.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=======\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.1.10",
    "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": "0198c160a3b687eff81065b9116a8f4efb693c925e9667e6f75a1498b53f9996",
                "md5": "0f903299cb2f9c9f64244f94262a4f4a",
                "sha256": "27a2eb76ff51f860bc47f7e54e403c2f7675ddf19bbd7c804f1a3606c997ee24"
            },
            "downloads": -1,
            "filename": "forcefield_step-2024.1.10-py2.py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "0f903299cb2f9c9f64244f94262a4f4a",
            "packagetype": "bdist_wheel",
            "python_version": "py2.py3",
            "requires_python": null,
            "size": 124943,
            "upload_time": "2024-01-10T16:16:09",
            "upload_time_iso_8601": "2024-01-10T16:16:09.949212Z",
            "url": "https://files.pythonhosted.org/packages/01/98/c160a3b687eff81065b9116a8f4efb693c925e9667e6f75a1498b53f9996/forcefield_step-2024.1.10-py2.py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "63eace46a359af739656d473e4386e9f94156e450c2c014f6d4121f4769aef2d",
                "md5": "013c8198e3d56d80c014d06a707aa28f",
                "sha256": "0e6e6a4fd71826668c3a69ac5bdec76152218fafc9c62cdf5a1c24e4699f691b"
            },
            "downloads": -1,
            "filename": "forcefield_step-2024.1.10.tar.gz",
            "has_sig": false,
            "md5_digest": "013c8198e3d56d80c014d06a707aa28f",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 403267,
            "upload_time": "2024-01-10T16:16:11",
            "upload_time_iso_8601": "2024-01-10T16:16:11.552387Z",
            "url": "https://files.pythonhosted.org/packages/63/ea/ce46a359af739656d473e4386e9f94156e450c2c014f6d4121f4769aef2d/forcefield_step-2024.1.10.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-01-10 16:16:11",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "molssi-seam",
    "github_project": "forcefield_step",
    "github_not_found": true,
    "lcname": "forcefield-step"
}
        
Elapsed time: 0.17015s