# Cowley short range order parameter modifier
This repository contains an OVITO modifier that calculates the Cowley short range order parameters from a precomputed bond topology, as well as a modifier for creating a bond topology from a set of nearest neighbors.
For use in a standalone Python script:
```bash
pip install cowley_sro_parameters
```
This code is intended to also interface with OVITO Pro, but this feature has not been tested. With OVITO Pro, you can install this modifier into your OVITO interface with:
```bash
ovitos -m pip install --user cowley_sro_parameters
```
An example of this repository used in a standalone script is in the [example/](https://github.com/muexly/cowley_sro_parameters/tree/master/example) directory. This package is a derivative of a larger work on vacancy concentration. If you find this package useful, please cite [our work on vacancy concentration](https://arxiv.org/abs/2402.07324) as well as the repository itself:
```bibtex
@misc{jeffries_sro_parameters,
author={Jacob Jeffries},
title={Cowley SRO Parameters Modifier},
howpublished={\url{https://github.com/muexly/cowley_sro_parameters}},
year={2023}
}
```
# Acknowledgements
The work was supported by the grant DE-SC0022980 funded by the U.S. Department of Energy, Office of Science.
Raw data
{
"_id": null,
"home_page": "https://github.com/muexly/cowley_sro_parameters",
"name": "cowley-sro-parameters",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": null,
"author": "Jacob Jeffries",
"author_email": "jwjeffr@clemson.edu",
"download_url": "https://files.pythonhosted.org/packages/9c/9b/961e78fc69e0aa642f595450b39ec40766d796691c290f7934159bf29e7f/cowley_sro_parameters-1.1.0.tar.gz",
"platform": null,
"description": "# Cowley short range order parameter modifier\n\nThis repository contains an OVITO modifier that calculates the Cowley short range order parameters from a precomputed bond topology, as well as a modifier for creating a bond topology from a set of nearest neighbors.\n\nFor use in a standalone Python script:\n\n```bash\npip install cowley_sro_parameters\n```\n\nThis code is intended to also interface with OVITO Pro, but this feature has not been tested. With OVITO Pro, you can install this modifier into your OVITO interface with:\n\n```bash\novitos -m pip install --user cowley_sro_parameters\n```\n\nAn example of this repository used in a standalone script is in the [example/](https://github.com/muexly/cowley_sro_parameters/tree/master/example) directory. This package is a derivative of a larger work on vacancy concentration. If you find this package useful, please cite [our work on vacancy concentration](https://arxiv.org/abs/2402.07324) as well as the repository itself:\n\n```bibtex\n@misc{jeffries_sro_parameters,\n author={Jacob Jeffries},\n title={Cowley SRO Parameters Modifier},\n howpublished={\\url{https://github.com/muexly/cowley_sro_parameters}},\n year={2023}\n}\n```\n\n# Acknowledgements\n\nThe work was supported by the grant DE-SC0022980 funded by the U.S. Department of Energy, Office of Science.\n",
"bugtrack_url": null,
"license": null,
"summary": null,
"version": "1.1.0",
"project_urls": {
"Homepage": "https://github.com/muexly/cowley_sro_parameters"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f5858a23936b5d4c134d41bdbebd0624c35a960e760987a9aaeab0ba9fdc636e",
"md5": "a08fc6bcf00f24dc4802e26904a0148e",
"sha256": "dda2b8ce3614c6627c82f7df6ff99d644427b9f7f7d67095c1c8d0fa716dbbf3"
},
"downloads": -1,
"filename": "cowley_sro_parameters-1.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a08fc6bcf00f24dc4802e26904a0148e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 4433,
"upload_time": "2024-03-22T18:54:30",
"upload_time_iso_8601": "2024-03-22T18:54:30.972057Z",
"url": "https://files.pythonhosted.org/packages/f5/85/8a23936b5d4c134d41bdbebd0624c35a960e760987a9aaeab0ba9fdc636e/cowley_sro_parameters-1.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "9c9b961e78fc69e0aa642f595450b39ec40766d796691c290f7934159bf29e7f",
"md5": "2746c2255d94253c21984bba71baecc8",
"sha256": "cd999cafdc93e99239bb7900c09d80a856284f4c450b00635a4d0b0742c9cc06"
},
"downloads": -1,
"filename": "cowley_sro_parameters-1.1.0.tar.gz",
"has_sig": false,
"md5_digest": "2746c2255d94253c21984bba71baecc8",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 3712,
"upload_time": "2024-03-22T18:54:31",
"upload_time_iso_8601": "2024-03-22T18:54:31.856587Z",
"url": "https://files.pythonhosted.org/packages/9c/9b/961e78fc69e0aa642f595450b39ec40766d796691c290f7934159bf29e7f/cowley_sro_parameters-1.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-22 18:54:31",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "muexly",
"github_project": "cowley_sro_parameters",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "cowley-sro-parameters"
}
JSON
