=====
iprPy
=====
Introduction
------------
The iprPy framework provides
- The calculation methodology scripts used by the NIST Interatomic potentials
Repository for evaluating crystalline and crystal defect materials properties,
- Tools allowing for users to interact with databases and the records contained
within to easily explore the results of the calculations, and
- Workflow tools that allow for preparing and performing high throughput runs
of the implemented calculation methods.
The design of the package aims for being user-friendly, open and transparent at
all levels. To this end
- All code is open source,
- Calculation documentation and the Python code can be easily accessed and
explored,
- Calculations can be performed individually or *en masse* using the workflow
tools,
- Command line options allow for runs to be set up and performed with limited
or no Python knowledge,
- Calculations are modular meaning that new methods can be easily added,
- Calculation methodology is separated from the workflow operations as much as
possible,
- Implementation of new calculations can be supported by sharing input/output
terms with existing calculations, and
- The results records are in a format that is both human and machine readable.
Documentation
-------------
- Documentation can be found in the doc directory or by visiting
https://www.ctcms.nist.gov/potentials/iprPy/.
- The notebook directory contains Jupyter Notebooks that outline how the
implemented calculation methods work and provides an example run.
- For help using the package, feel free to contact potentials@nist.gov or
submit an issue or pull request to the https://github.com/lmhale99/iprPy
github repository.
Raw data
{
"_id": null,
"home_page": "https://github.com/usnistgov/iprPy",
"name": "iprPy",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "atom, atomic, atomistic, molecular dynamics, high-throughput, interatomic potential",
"author": "Lucas Hale",
"author_email": "lucas.hale@nist.gov",
"download_url": "https://files.pythonhosted.org/packages/a9/10/10904ddc62f7562f6854e2481067da62ecc8d375cc60ba2b3bde4407c786/iprpy-0.11.8.tar.gz",
"platform": null,
"description": "=====\niprPy\n=====\n\nIntroduction\n------------\n\nThe iprPy framework provides\n\n- The calculation methodology scripts used by the NIST Interatomic potentials\n Repository for evaluating crystalline and crystal defect materials properties,\n- Tools allowing for users to interact with databases and the records contained\n within to easily explore the results of the calculations, and\n- Workflow tools that allow for preparing and performing high throughput runs\n of the implemented calculation methods.\n\nThe design of the package aims for being user-friendly, open and transparent at\nall levels. To this end\n\n- All code is open source,\n- Calculation documentation and the Python code can be easily accessed and\n explored,\n- Calculations can be performed individually or *en masse* using the workflow\n tools,\n- Command line options allow for runs to be set up and performed with limited\n or no Python knowledge,\n- Calculations are modular meaning that new methods can be easily added,\n- Calculation methodology is separated from the workflow operations as much as\n possible,\n- Implementation of new calculations can be supported by sharing input/output\n terms with existing calculations, and\n- The results records are in a format that is both human and machine readable. \n\n\nDocumentation\n-------------\n\n- Documentation can be found in the doc directory or by visiting \n https://www.ctcms.nist.gov/potentials/iprPy/. \n\n- The notebook directory contains Jupyter Notebooks that outline how the\n implemented calculation methods work and provides an example run.\n\n- For help using the package, feel free to contact potentials@nist.gov or\n submit an issue or pull request to the https://github.com/lmhale99/iprPy\n github repository. \n",
"bugtrack_url": null,
"license": null,
"summary": "Interatomic Potential Repository Python Property Calculations and Tools",
"version": "0.11.8",
"project_urls": {
"Homepage": "https://github.com/usnistgov/iprPy"
},
"split_keywords": [
"atom",
" atomic",
" atomistic",
" molecular dynamics",
" high-throughput",
" interatomic potential"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "7218f05f62e5fbae965d481bfcf5d77b4c00171554fb81f761e3ee9301516464",
"md5": "00b38bc04555e998c21a4a9ec726ba25",
"sha256": "cce8355e98639e266740cdcc1f5e9fd378b584ca947505fe563d3ab6c75af09e"
},
"downloads": -1,
"filename": "iprpy-0.11.8-py3-none-any.whl",
"has_sig": false,
"md5_digest": "00b38bc04555e998c21a4a9ec726ba25",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 1477740,
"upload_time": "2025-08-05T16:45:41",
"upload_time_iso_8601": "2025-08-05T16:45:41.636496Z",
"url": "https://files.pythonhosted.org/packages/72/18/f05f62e5fbae965d481bfcf5d77b4c00171554fb81f761e3ee9301516464/iprpy-0.11.8-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "a91010904ddc62f7562f6854e2481067da62ecc8d375cc60ba2b3bde4407c786",
"md5": "589f9fe4a372368501b1d82414c8b2f2",
"sha256": "9ce2160dc2c5a5f5381ad6c7301f29800241fee4544d4fca8cff186104f59c01"
},
"downloads": -1,
"filename": "iprpy-0.11.8.tar.gz",
"has_sig": false,
"md5_digest": "589f9fe4a372368501b1d82414c8b2f2",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 1581568,
"upload_time": "2025-08-05T16:45:43",
"upload_time_iso_8601": "2025-08-05T16:45:43.272218Z",
"url": "https://files.pythonhosted.org/packages/a9/10/10904ddc62f7562f6854e2481067da62ecc8d375cc60ba2b3bde4407c786/iprpy-0.11.8.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-08-05 16:45:43",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "usnistgov",
"github_project": "iprPy",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [
{
"name": "DataModelDict",
"specs": []
},
{
"name": "numpy",
"specs": []
},
{
"name": "matplotlib",
"specs": []
},
{
"name": "scipy",
"specs": []
},
{
"name": "pandas",
"specs": []
},
{
"name": "atomman",
"specs": [
[
">=",
"1.4.11"
]
]
},
{
"name": "requests",
"specs": []
},
{
"name": "bokeh",
"specs": []
},
{
"name": "plotly",
"specs": []
},
{
"name": "phonopy",
"specs": []
},
{
"name": "spglib",
"specs": []
}
],
"lcname": "iprpy"
}
JSON
