pyiron-vasp


Namepyiron-vasp JSON
Version 0.2.7 PyPI version JSON
download
home_pageNone
SummaryParser for the Vienna Ab initio Simulation Package (VASP)
upload_time2025-07-09 19:28:13
maintainerNone
docs_urlNone
authorNone
requires_python<3.14,>=3.9
licenseBSD 3-Clause License Copyright (c) 2021, Max-Planck-Institut für Eisenforschung GmbH - Computational Materials Design (CM) Department All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. * Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
keywords pyiron
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # pyiron_vasp

[![Pipeline](https://github.com/pyiron/pyiron_vasp/actions/workflows/pipeline.yml/badge.svg)](https://github.com/pyiron/pyiron_vasp/actions/workflows/pipeline.yml)
[![codecov](https://codecov.io/gh/pyiron/pyiron_vasp/graph/badge.svg?token=PWWLjnbDJz)](https://codecov.io/gh/pyiron/pyiron_vasp)

Parser for the Vienna Ab initio Simulation Package (VASP)

## Installation 
Via pip
```
pip install pyiron_vasp
```

Via conda
```
conda install -c conda-forge pyiron_vasp
```

## Usage
Parse an directory with VASP output files 
```python
from pyiron_vasp.vasp.output import parse_vasp_output

output_dict = parse_vasp_output(working_directory="path/to/calculation")
```

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "pyiron-vasp",
    "maintainer": null,
    "docs_url": null,
    "requires_python": "<3.14,>=3.9",
    "maintainer_email": null,
    "keywords": "pyiron",
    "author": null,
    "author_email": "Jan Janssen <janssen@mpie.de>",
    "download_url": "https://files.pythonhosted.org/packages/b7/59/7fd049f424d2fd535d9b134a45aa2587ae7c7a65d37d9b19d2770077f827/pyiron_vasp-0.2.7.tar.gz",
    "platform": null,
    "description": "# pyiron_vasp\n\n[![Pipeline](https://github.com/pyiron/pyiron_vasp/actions/workflows/pipeline.yml/badge.svg)](https://github.com/pyiron/pyiron_vasp/actions/workflows/pipeline.yml)\n[![codecov](https://codecov.io/gh/pyiron/pyiron_vasp/graph/badge.svg?token=PWWLjnbDJz)](https://codecov.io/gh/pyiron/pyiron_vasp)\n\nParser for the Vienna Ab initio Simulation Package (VASP)\n\n## Installation \nVia pip\n```\npip install pyiron_vasp\n```\n\nVia conda\n```\nconda install -c conda-forge pyiron_vasp\n```\n\n## Usage\nParse an directory with VASP output files \n```python\nfrom pyiron_vasp.vasp.output import parse_vasp_output\n\noutput_dict = parse_vasp_output(working_directory=\"path/to/calculation\")\n```\n",
    "bugtrack_url": null,
    "license": "BSD 3-Clause License\n        \n        Copyright (c) 2021, Max-Planck-Institut f\u00fcr Eisenforschung GmbH - Computational Materials Design (CM) Department\n        All rights reserved.\n        \n        Redistribution and use in source and binary forms, with or without\n        modification, are permitted provided that the following conditions are met:\n        \n        * Redistributions of source code must retain the above copyright notice, this\n          list of conditions and the following disclaimer.\n        \n        * Redistributions in binary form must reproduce the above copyright notice,\n          this list of conditions and the following disclaimer in the documentation\n          and/or other materials provided with the distribution.\n        \n        * Neither the name of the copyright holder nor the names of its\n          contributors may be used to endorse or promote products derived from\n          this software without specific prior written permission.\n        \n        THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS \"AS IS\"\n        AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE\n        IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE\n        DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE\n        FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL\n        DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR\n        SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER\n        CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,\n        OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE\n        OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\n        ",
    "summary": "Parser for the Vienna Ab initio Simulation Package (VASP)",
    "version": "0.2.7",
    "project_urls": {
        "Documentation": "https://pyiron_vasp.readthedocs.io",
        "Homepage": "https://pyiron.org",
        "Repository": "https://github.com/pyiron/pyiron_vasp"
    },
    "split_keywords": [
        "pyiron"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "4053b6fe7a533471bc13e6247674f92cb78a7847080bb0a7884ee0bf2a8c4d75",
                "md5": "4f16017c02940f947dbde01d4b60df5d",
                "sha256": "a26e06d35a3799a7039712816928e3c9aeb55a1f529493d0c465bd64ae99d540"
            },
            "downloads": -1,
            "filename": "pyiron_vasp-0.2.7-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "4f16017c02940f947dbde01d4b60df5d",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<3.14,>=3.9",
            "size": 54731,
            "upload_time": "2025-07-09T19:28:12",
            "upload_time_iso_8601": "2025-07-09T19:28:12.317131Z",
            "url": "https://files.pythonhosted.org/packages/40/53/b6fe7a533471bc13e6247674f92cb78a7847080bb0a7884ee0bf2a8c4d75/pyiron_vasp-0.2.7-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "b7597fd049f424d2fd535d9b134a45aa2587ae7c7a65d37d9b19d2770077f827",
                "md5": "d35feba0f303ed9af26e8ce93d675793",
                "sha256": "2a6b359a345f418a6e7c793d38d8fadb17763cd7d8f92fd341b4281080feeeeb"
            },
            "downloads": -1,
            "filename": "pyiron_vasp-0.2.7.tar.gz",
            "has_sig": false,
            "md5_digest": "d35feba0f303ed9af26e8ce93d675793",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<3.14,>=3.9",
            "size": 42071,
            "upload_time": "2025-07-09T19:28:13",
            "upload_time_iso_8601": "2025-07-09T19:28:13.940624Z",
            "url": "https://files.pythonhosted.org/packages/b7/59/7fd049f424d2fd535d9b134a45aa2587ae7c7a65d37d9b19d2770077f827/pyiron_vasp-0.2.7.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-07-09 19:28:13",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "pyiron",
    "github_project": "pyiron_vasp",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "pyiron-vasp"
}
        
Elapsed time: 2.29028s