pymatgen-analysis-diffusion


Namepymatgen-analysis-diffusion JSON
Version 2023.8.15 PyPI version JSON
download
home_pagehttps://github.com/materialsvirtuallab/pymatgen-diffusion/
SummaryAdd-on to pymatgen for diffusion analysis.
upload_time2023-08-16 04:00:39
maintainermaterials virtual lab
docs_urlNone
authormaterials virtual lab
requires_python
licenseBSD
keywords vasp diffusion molecular dynamics md
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            .. image:: https://github.com/materialsvirtuallab/pymatgen-diffusion/actions/workflows/testing.yml/badge.svg
      :alt: CI Status
      :target: https://github.com/materialsvirtuallab/pymatgen-diffusion/actions/workflows/testing.yml

.. image:: https://coveralls.io/repos/github/materialsvirtuallab/pymatgen-diffusion/badge.svg?branch=master
      :target: https://coveralls.io/github/materialsvirtuallab/pymatgen-diffusion?branch=master

pymatgen-analysis-diffusion
===========================

Formerly pymatgen-diffusion, this is an add-on to pymatgen for diffusion
analysis that is developed by the Materials Virtual Lab. Note that it relies on
pymatgen for structural manipulations, file io, and preliminary analyses. This is
and will always be, a scientific work in progress. Pls check back regularly for
more details.

Major Update (v2021.3.5)
========================

pymatgen-analysis-diffusion is now released as a namespace package `pymatgen-analysis-diffusion` on PyPI. It should be
imported via `pymatgen.analysis.diffusion` instead `pymatgen_diffusion`. To install this package via pip::

    pip install pymatgen-analysis-diffusion

Features (non-exhaustive!)
==========================

1. Van-Hove analysis
2. Probability density
3. Clustering (e.g., k-means with periodic boundary conditions).
4. Migration path finding and IDPP.

Citing
======

If you use pymatgen-diffusion in your research, please cite the following
work::

    Deng, Z.; Zhu, Z.; Chu, I.H.; Ong, S. P. Data-Driven First-Principles
    Methods for the Study and Design of Alkali Superionic Conductors,
    Chem. Mater., 2016, acs.chemmater.6b02648, doi:10.1021/acs.chemmater.6b02648.

You should also include the following citation for the pymatgen core package
given that it forms the basis for most of the analyses::

    Shyue Ping Ong, William Davidson Richards, Anubhav Jain, Geoffroy Hautier,
    Michael Kocher, Shreyas Cholia, Dan Gunter, Vincent Chevrier, Kristin A.
    Persson, Gerbrand Ceder. *Python Materials Genomics (pymatgen) : A Robust,
    Open-Source Python Library for Materials Analysis.* Computational
    Materials Science, 2013, 68, 314-319. doi:10.1016/j.commatsci.2012.10.028.

In addtion, some of the analyses may also have relevant publications that
you should cite. Please consult the documentation of each module.

Contributing
============

We welcome contributions in all forms. If you'd like to contribute, please
fork this repository, make changes and send us a pull request!

Acknowledgements
================

We gratefully acknowledge funding from the following agencies for the
development of this code:

1. US National Science Foundation’s Designing Materials to Revolutionize and
   Engineer our Future (DMREF) program under Grant No. 1436976 for the AIMD
   analysis package.
2. US Department of Energy, Office of Science, Basic Energy Sciences under
   Award No. DE-SC0012118 for the NEB analysis package.

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/materialsvirtuallab/pymatgen-diffusion/",
    "name": "pymatgen-analysis-diffusion",
    "maintainer": "materials virtual lab",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "VASP,diffusion,molecular dynamics,MD",
    "author": "materials virtual lab",
    "author_email": "ongsp@eng.ucsd.edu",
    "download_url": "https://files.pythonhosted.org/packages/d9/99/faa307afbef43a80108bc2aaea92f4667e2cab24a79ee4896f0c2ff8eccc/pymatgen-analysis-diffusion-2023.8.15.tar.gz",
    "platform": null,
    "description": ".. image:: https://github.com/materialsvirtuallab/pymatgen-diffusion/actions/workflows/testing.yml/badge.svg\n      :alt: CI Status\n      :target: https://github.com/materialsvirtuallab/pymatgen-diffusion/actions/workflows/testing.yml\n\n.. image:: https://coveralls.io/repos/github/materialsvirtuallab/pymatgen-diffusion/badge.svg?branch=master\n      :target: https://coveralls.io/github/materialsvirtuallab/pymatgen-diffusion?branch=master\n\npymatgen-analysis-diffusion\n===========================\n\nFormerly pymatgen-diffusion, this is an add-on to pymatgen for diffusion\nanalysis that is developed by the Materials Virtual Lab. Note that it relies on\npymatgen for structural manipulations, file io, and preliminary analyses. This is\nand will always be, a scientific work in progress. Pls check back regularly for\nmore details.\n\nMajor Update (v2021.3.5)\n========================\n\npymatgen-analysis-diffusion is now released as a namespace package `pymatgen-analysis-diffusion` on PyPI. It should be\nimported via `pymatgen.analysis.diffusion` instead `pymatgen_diffusion`. To install this package via pip::\n\n    pip install pymatgen-analysis-diffusion\n\nFeatures (non-exhaustive!)\n==========================\n\n1. Van-Hove analysis\n2. Probability density\n3. Clustering (e.g., k-means with periodic boundary conditions).\n4. Migration path finding and IDPP.\n\nCiting\n======\n\nIf you use pymatgen-diffusion in your research, please cite the following\nwork::\n\n    Deng, Z.; Zhu, Z.; Chu, I.H.; Ong, S. P. Data-Driven First-Principles\n    Methods for the Study and Design of Alkali Superionic Conductors,\n    Chem. Mater., 2016, acs.chemmater.6b02648, doi:10.1021/acs.chemmater.6b02648.\n\nYou should also include the following citation for the pymatgen core package\ngiven that it forms the basis for most of the analyses::\n\n    Shyue Ping Ong, William Davidson Richards, Anubhav Jain, Geoffroy Hautier,\n    Michael Kocher, Shreyas Cholia, Dan Gunter, Vincent Chevrier, Kristin A.\n    Persson, Gerbrand Ceder. *Python Materials Genomics (pymatgen) : A Robust,\n    Open-Source Python Library for Materials Analysis.* Computational\n    Materials Science, 2013, 68, 314-319. doi:10.1016/j.commatsci.2012.10.028.\n\nIn addtion, some of the analyses may also have relevant publications that\nyou should cite. Please consult the documentation of each module.\n\nContributing\n============\n\nWe welcome contributions in all forms. If you'd like to contribute, please\nfork this repository, make changes and send us a pull request!\n\nAcknowledgements\n================\n\nWe gratefully acknowledge funding from the following agencies for the\ndevelopment of this code:\n\n1. US National Science Foundation\u2019s Designing Materials to Revolutionize and\n   Engineer our Future (DMREF) program under Grant No. 1436976 for the AIMD\n   analysis package.\n2. US Department of Energy, O\ufb03ce of Science, Basic Energy Sciences under\n   Award No. DE-SC0012118 for the NEB analysis package.\n",
    "bugtrack_url": null,
    "license": "BSD",
    "summary": "Add-on to pymatgen for diffusion analysis.",
    "version": "2023.8.15",
    "project_urls": {
        "Homepage": "https://github.com/materialsvirtuallab/pymatgen-diffusion/"
    },
    "split_keywords": [
        "vasp",
        "diffusion",
        "molecular dynamics",
        "md"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "5cfed090b8973caf596b37197db52492e303722e823eacd28313670bf976d3bb",
                "md5": "4b28817c767f708a3d0ac7391e882136",
                "sha256": "4d4bb33646647edbe9a9467312b97c5983a8ceede53025dc313c46006e8f5030"
            },
            "downloads": -1,
            "filename": "pymatgen_analysis_diffusion-2023.8.15-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "4b28817c767f708a3d0ac7391e882136",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 92626,
            "upload_time": "2023-08-16T04:00:35",
            "upload_time_iso_8601": "2023-08-16T04:00:35.997512Z",
            "url": "https://files.pythonhosted.org/packages/5c/fe/d090b8973caf596b37197db52492e303722e823eacd28313670bf976d3bb/pymatgen_analysis_diffusion-2023.8.15-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "d999faa307afbef43a80108bc2aaea92f4667e2cab24a79ee4896f0c2ff8eccc",
                "md5": "9733a8c1a67a0601323b9cfcbd47ef42",
                "sha256": "d19835320a2cb80ab2160234978a39f4a01994ba7f6eac6de5a4c93e032a9251"
            },
            "downloads": -1,
            "filename": "pymatgen-analysis-diffusion-2023.8.15.tar.gz",
            "has_sig": false,
            "md5_digest": "9733a8c1a67a0601323b9cfcbd47ef42",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 78889,
            "upload_time": "2023-08-16T04:00:39",
            "upload_time_iso_8601": "2023-08-16T04:00:39.226496Z",
            "url": "https://files.pythonhosted.org/packages/d9/99/faa307afbef43a80108bc2aaea92f4667e2cab24a79ee4896f0c2ff8eccc/pymatgen-analysis-diffusion-2023.8.15.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-08-16 04:00:39",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "materialsvirtuallab",
    "github_project": "pymatgen-diffusion",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [],
    "lcname": "pymatgen-analysis-diffusion"
}
        
Elapsed time: 0.10001s