| Name | hiPhive JSON |
| Version |
1.5
JSON |
| download |
| home_page | None |
| Summary | High-order force constants for the masses |
| upload_time | 2025-07-28 21:50:13 |
| maintainer | None |
| docs_url | None |
| author | Fredrik Eriksson, Erik Fransson, Paul Erhart |
| requires_python | >=3.9 |
| license | MIT License
Copyright (c) 2018 materials-modeling
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
|
| keywords |
chemistry
physics
scientific
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
hiPhive
=======
**hiPhive** is a tool for efficiently extracting high-order force constants from atomistic simulations, most commonly density functional theory calculations.
A detailed description of the functionality provided as well as an extensive tutorial can be found in the `user guide <https://hiphive.materialsmodeling.org/>`_.
Complete examples of using **hiphive** for force constants extraction can be found in the `hiphive-examples repository <https://gitlab.com/materials-modeling/hiphive-examples/>`_.
**hiPhive** is written in Python, which allows easy integration with countless first-principles codes and analysis tools accessible in Python, and allows for a simple and intuitive user interface.
For example using the following snippet one can train a force constant potential:
.. code-block:: python
cs = ClusterSpace(primitive_cell, cutoffs)
sc = StructureContainer(cs, list_of_training_structure)
opt = Optimizer(sc.get_fit_data())
opt.train()
fcp = ForceConstantPotential(cs, opt.parameters)
after which it can be used in various ways, e.g., for generating phonon dispersions, computing phonon lifetimes, or running molecular dynamics simulations.
For questions and help please use the `hiphive discussion forum on matsci.org <https://matsci.org/hiphive>`_.
**hiPhive** and its development are hosted on `gitlab <https://gitlab.com/materials-modeling/hiphive>`_.
Installation
------------
**hiPhive** can be installed via `pip`::
pip3 install hiphive
or via `conda <https://anaconda.org/conda-forge/hiphive>`_::
conda install -c conda-forge hiphive
**hiPhive** requires Python3 and invokes functionality from several external libraries including the
`atomic simulation environment <https://wiki.fysik.dtu.dk/ase>`_,
`scikit-learn <http://scikit-learn.org/>`_,
`spglib <https://phonopy.github.io/spglib/>`_,
`SymPy <http://www.sympy.org/en/index.html>`_, and
`trainstation <https://trainstation.materialsmodeling.org/>`_.
Please consult the `installation section of the user guide <https://hiphive.materialsmodeling.org/installation.html>`_ for details.
Credits
-------
**hiPhive** has been developed at the `Department of Physics <https://www.chalmers.se/en/departments/physics/Pages/default.aspx>`_ of `Chalmers University of Technology <https://www.chalmers.se/>`_ (Gothenburg, Sweden) in the `Condensed Matter and Materials Theory division <http://www.materialsmodeling.org>`_.
When using **hiPhive** in your research please cite the following paper:
| Fredrik Eriksson, Erik Fransson, and Paul Erhart
| *The Hiphive Package for the Extraction of HighâOrder Force Constants by Machine Learning*
| Adv. Theory. Sim., 1800184 (2019)
| `doi: 10.1002/adts.201800184 <https://doi.org/10.1002/adts.201800184>`_
Please consult the `Credits <https://hiphive.materialsmodeling.org/credits>`_ page of the documentation for additional references.
Raw data
{
"_id": null,
"home_page": null,
"name": "hiPhive",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": "The hiPhive developers team <hiphive@materialsmodeling.org>",
"keywords": "chemistry, physics, scientific",
"author": "Fredrik Eriksson, Erik Fransson, Paul Erhart",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/16/6a/697642c91eafefc253109114c2f8f69d39c997272f140e750c148e330859/hiphive-1.5.tar.gz",
"platform": null,
"description": "hiPhive\n=======\n\n**hiPhive** is a tool for efficiently extracting high-order force constants from atomistic simulations, most commonly density functional theory calculations.\nA detailed description of the functionality provided as well as an extensive tutorial can be found in the `user guide <https://hiphive.materialsmodeling.org/>`_.\nComplete examples of using **hiphive** for force constants extraction can be found in the `hiphive-examples repository <https://gitlab.com/materials-modeling/hiphive-examples/>`_.\n\n**hiPhive** is written in Python, which allows easy integration with countless first-principles codes and analysis tools accessible in Python, and allows for a simple and intuitive user interface.\nFor example using the following snippet one can train a force constant potential:\n\n.. code-block:: python\n\n cs = ClusterSpace(primitive_cell, cutoffs)\n sc = StructureContainer(cs, list_of_training_structure)\n opt = Optimizer(sc.get_fit_data())\n opt.train()\n fcp = ForceConstantPotential(cs, opt.parameters)\n\nafter which it can be used in various ways, e.g., for generating phonon dispersions, computing phonon lifetimes, or running molecular dynamics simulations.\n\nFor questions and help please use the `hiphive discussion forum on matsci.org <https://matsci.org/hiphive>`_.\n**hiPhive** and its development are hosted on `gitlab <https://gitlab.com/materials-modeling/hiphive>`_.\n\n\nInstallation\n------------\n\n**hiPhive** can be installed via `pip`::\n\n pip3 install hiphive\n\nor via `conda <https://anaconda.org/conda-forge/hiphive>`_::\n\n conda install -c conda-forge hiphive\n\n**hiPhive** requires Python3 and invokes functionality from several external libraries including the\n`atomic simulation environment <https://wiki.fysik.dtu.dk/ase>`_,\n`scikit-learn <http://scikit-learn.org/>`_,\n`spglib <https://phonopy.github.io/spglib/>`_,\n`SymPy <http://www.sympy.org/en/index.html>`_, and\n`trainstation <https://trainstation.materialsmodeling.org/>`_.\nPlease consult the `installation section of the user guide <https://hiphive.materialsmodeling.org/installation.html>`_ for details.\n\n\nCredits\n-------\n\n**hiPhive** has been developed at the `Department of Physics <https://www.chalmers.se/en/departments/physics/Pages/default.aspx>`_ of `Chalmers University of Technology <https://www.chalmers.se/>`_ (Gothenburg, Sweden) in the `Condensed Matter and Materials Theory division <http://www.materialsmodeling.org>`_.\n\nWhen using **hiPhive** in your research please cite the following paper:\n\n| Fredrik Eriksson, Erik Fransson, and Paul Erhart\n| *The Hiphive Package for the Extraction of High\u2010Order Force Constants by Machine Learning*\n| Adv. Theory. Sim., 1800184 (2019)\n| `doi: 10.1002/adts.201800184 <https://doi.org/10.1002/adts.201800184>`_\n\nPlease consult the `Credits <https://hiphive.materialsmodeling.org/credits>`_ page of the documentation for additional references.\n",
"bugtrack_url": null,
"license": "MIT License\n \n Copyright (c) 2018 materials-modeling\n \n Permission is hereby granted, free of charge, to any person obtaining a copy\n of this software and associated documentation files (the \"Software\"), to deal\n in the Software without restriction, including without limitation the rights\n to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n copies of the Software, and to permit persons to whom the Software is\n furnished to do so, subject to the following conditions:\n \n The above copyright notice and this permission notice shall be included in all\n copies or substantial portions of the Software.\n \n THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n SOFTWARE.\n ",
"summary": "High-order force constants for the masses",
"version": "1.5",
"project_urls": {
"Documentation": "https://hiphive.materialsmodeling.org",
"Repository": "https://gitlab.com/materials-modeling/hiphive/"
},
"split_keywords": [
"chemistry",
" physics",
" scientific"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "7cb31c2a59e6a84b543b2278ce505d7786bbc0c5158d6889677b86ab6db63951",
"md5": "3241c815f4994d58a1f689bd081cd198",
"sha256": "1fcc3025a9895e679209c71be594787ff57e84c37648dafc97f32941fac2f370"
},
"downloads": -1,
"filename": "hiphive-1.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "3241c815f4994d58a1f689bd081cd198",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 89284,
"upload_time": "2025-07-28T21:50:11",
"upload_time_iso_8601": "2025-07-28T21:50:11.304751Z",
"url": "https://files.pythonhosted.org/packages/7c/b3/1c2a59e6a84b543b2278ce505d7786bbc0c5158d6889677b86ab6db63951/hiphive-1.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "166a697642c91eafefc253109114c2f8f69d39c997272f140e750c148e330859",
"md5": "c6a3c122f0607a077cec0130a84236f8",
"sha256": "a8162686265aed88cfa6ad2721f39629102525100879484530cb7c25269ac386"
},
"downloads": -1,
"filename": "hiphive-1.5.tar.gz",
"has_sig": false,
"md5_digest": "c6a3c122f0607a077cec0130a84236f8",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 71384,
"upload_time": "2025-07-28T21:50:13",
"upload_time_iso_8601": "2025-07-28T21:50:13.544951Z",
"url": "https://files.pythonhosted.org/packages/16/6a/697642c91eafefc253109114c2f8f69d39c997272f140e750c148e330859/hiphive-1.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-28 21:50:13",
"github": false,
"gitlab": true,
"bitbucket": false,
"codeberg": false,
"gitlab_user": "materials-modeling",
"gitlab_project": "hiphive",
"lcname": "hiphive"
}
