=====
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": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"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/fb/06/059beb42c6d4bc82b320c20a0bc8efcb5d08af77c7dbd6d2abf23bde9935/iprPy-0.11.6.tar.gz",
"platform": null,
"description": "=====\r\niprPy\r\n=====\r\n\r\nIntroduction\r\n------------\r\n\r\nThe iprPy framework provides\r\n\r\n- The calculation methodology scripts used by the NIST Interatomic potentials\r\n Repository for evaluating crystalline and crystal defect materials properties,\r\n- Tools allowing for users to interact with databases and the records contained\r\n within to easily explore the results of the calculations, and\r\n- Workflow tools that allow for preparing and performing high throughput runs\r\n of the implemented calculation methods.\r\n\r\nThe design of the package aims for being user-friendly, open and transparent at\r\nall levels. To this end\r\n\r\n- All code is open source,\r\n- Calculation documentation and the Python code can be easily accessed and\r\n explored,\r\n- Calculations can be performed individually or *en masse* using the workflow\r\n tools,\r\n- Command line options allow for runs to be set up and performed with limited\r\n or no Python knowledge,\r\n- Calculations are modular meaning that new methods can be easily added,\r\n- Calculation methodology is separated from the workflow operations as much as\r\n possible,\r\n- Implementation of new calculations can be supported by sharing input/output\r\n terms with existing calculations, and\r\n- The results records are in a format that is both human and machine readable. \r\n\r\n\r\nDocumentation\r\n-------------\r\n\r\n- Documentation can be found in the doc directory or by visiting \r\n https://www.ctcms.nist.gov/potentials/iprPy/. \r\n\r\n- The notebook directory contains Jupyter Notebooks that outline how the\r\n implemented calculation methods work and provides an example run.\r\n\r\n- For help using the package, feel free to contact potentials@nist.gov or\r\n submit an issue or pull request to the https://github.com/lmhale99/iprPy\r\n github repository. \r\n",
"bugtrack_url": null,
"license": "",
"summary": "Interatomic Potential Repository Python Property Calculations and Tools",
"version": "0.11.6",
"project_urls": {
"Homepage": "https://github.com/usnistgov/iprPy"
},
"split_keywords": [
"atom",
"atomic",
"atomistic",
"molecular dynamics",
"high-throughput",
"interatomic potential"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "6061f5f1080b1b62b5a95cca49935173ae7fdb6e345dd0d28d1d7feb4767fa76",
"md5": "6b3e03fe87da57c999909833c73d15ab",
"sha256": "78562289ff66dcebb8a426d01abe01cfe2bb3c32f7060dec1dac7264373a7916"
},
"downloads": -1,
"filename": "iprPy-0.11.6-py3-none-any.whl",
"has_sig": false,
"md5_digest": "6b3e03fe87da57c999909833c73d15ab",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 1225422,
"upload_time": "2023-07-31T21:07:32",
"upload_time_iso_8601": "2023-07-31T21:07:32.387660Z",
"url": "https://files.pythonhosted.org/packages/60/61/f5f1080b1b62b5a95cca49935173ae7fdb6e345dd0d28d1d7feb4767fa76/iprPy-0.11.6-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "fb06059beb42c6d4bc82b320c20a0bc8efcb5d08af77c7dbd6d2abf23bde9935",
"md5": "3fe42ff88f9f77c830f7cdaf79f8e6ac",
"sha256": "5e01d41f86100e710de2cd2e7b5f548707ee5c551b519d4bdc2cef4aba69f59a"
},
"downloads": -1,
"filename": "iprPy-0.11.6.tar.gz",
"has_sig": false,
"md5_digest": "3fe42ff88f9f77c830f7cdaf79f8e6ac",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 1071632,
"upload_time": "2023-07-31T21:07:34",
"upload_time_iso_8601": "2023-07-31T21:07:34.455975Z",
"url": "https://files.pythonhosted.org/packages/fb/06/059beb42c6d4bc82b320c20a0bc8efcb5d08af77c7dbd6d2abf23bde9935/iprPy-0.11.6.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-07-31 21:07:34",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "usnistgov",
"github_project": "iprPy",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "iprpy"
}
JSON
