NshellFinder


NameNshellFinder JSON
Version 0.0.5 PyPI version JSON
download
home_page
SummaryOVITO Python modifier to find n-th shell nearest neighbors.
upload_time2024-03-13 23:24:01
maintainer
docs_urlNone
author
requires_python>=3.7
licenseMIT License
keywords ovito python-modifier
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # NShellFinder
![PyPI Version](https://img.shields.io/pypi/v/nshellfinder.svg) ![PyPI Downloads](https://static.pepy.tech/badge/nshellfinder) ![tests](https://github.com/killiansheriff/NShellFinder/actions/workflows/python-tests.yml/badge.svg)

Ovito Python modifier to find the n-th coordination shell neighbors. 

## Utilisation 
Here is an example on how to find the indices of nearest neighbors -- cluster by shells up to certain cutoff -- for the fcc crystal structure. The scrip can be found in the ``examples/`` folder.  

```python
from ovito.io import import_file
from NshellFinder import NshellFinder

pipeline = import_file("fcc.dump")
mod = NshellFinder(crystal_structure="fcc", cutoff=18.2)
pipeline.modifiers.append(mod)
data = pipeline.compute()

neighbor_indices_per_shell = data.attributes["Neighbor indices per shell"]
# (number of nearest neighbor shells up to cutoff, number of atoms, number of nearest neighbors in the shell)

first_nn = neighbor_indices_per_shell[0] # (number of atoms, 12 first nearest neigbors)
second_nn = neighbor_indices_per_shell[1] # (number of atoms, 6 second nearest neighbors)
```


## Installation
For a standalone Python package or Conda environment, please use:
```bash
pip install --user NshellFinder
```

For *OVITO PRO* built-in Python interpreter, please use:
```bash
ovitos -m pip install --user NshellFinder
```

If you want to install the lastest git commit, please replace ``NshellFinder`` by ``git+https://github.com/killiansheriff/NshellFinder.git``.

## Contact
If any questions, feel free to contact me (ksheriff at mit dot edu).

## References & Citing 
If you use this repository in your work, please cite:

```
@article{TBD,
  title={TBD},
  author={Sheriff, Killian and Cao, Yifan and Freitas, Rodrigo},
  journal={arXiv preprint TBD},
  year={2024}
}
```

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "NshellFinder",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.7",
    "maintainer_email": "Killian Sheriff <ksheriff@mit.edu>",
    "keywords": "ovito,python-modifier",
    "author": "",
    "author_email": "Killian Sheriff <ksheriff@mit.edu>",
    "download_url": "https://files.pythonhosted.org/packages/6a/e0/1f5f3f55e2306ea73abcaffd89e95953d05f6f105d9d416810f0e1039708/NshellFinder-0.0.5.tar.gz",
    "platform": null,
    "description": "# NShellFinder\n![PyPI Version](https://img.shields.io/pypi/v/nshellfinder.svg) ![PyPI Downloads](https://static.pepy.tech/badge/nshellfinder) ![tests](https://github.com/killiansheriff/NShellFinder/actions/workflows/python-tests.yml/badge.svg)\n\nOvito Python modifier to find the n-th coordination shell neighbors. \n\n## Utilisation \nHere is an example on how to find the indices of nearest neighbors -- cluster by shells up to certain cutoff -- for the fcc crystal structure. The scrip can be found in the ``examples/`` folder.  \n\n```python\nfrom ovito.io import import_file\nfrom NshellFinder import NshellFinder\n\npipeline = import_file(\"fcc.dump\")\nmod = NshellFinder(crystal_structure=\"fcc\", cutoff=18.2)\npipeline.modifiers.append(mod)\ndata = pipeline.compute()\n\nneighbor_indices_per_shell = data.attributes[\"Neighbor indices per shell\"]\n# (number of nearest neighbor shells up to cutoff, number of atoms, number of nearest neighbors in the shell)\n\nfirst_nn = neighbor_indices_per_shell[0] # (number of atoms, 12 first nearest neigbors)\nsecond_nn = neighbor_indices_per_shell[1] # (number of atoms, 6 second nearest neighbors)\n```\n\n\n## Installation\nFor a standalone Python package or Conda environment, please use:\n```bash\npip install --user NshellFinder\n```\n\nFor *OVITO PRO* built-in Python interpreter, please use:\n```bash\novitos -m pip install --user NshellFinder\n```\n\nIf you want to install the lastest git commit, please replace ``NshellFinder`` by ``git+https://github.com/killiansheriff/NshellFinder.git``.\n\n## Contact\nIf any questions, feel free to contact me (ksheriff at mit dot edu).\n\n## References & Citing \nIf you use this repository in your work, please cite:\n\n```\n@article{TBD,\n  title={TBD},\n  author={Sheriff, Killian and Cao, Yifan and Freitas, Rodrigo},\n  journal={arXiv preprint TBD},\n  year={2024}\n}\n```\n",
    "bugtrack_url": null,
    "license": "MIT License",
    "summary": "OVITO Python modifier to find n-th shell nearest neighbors.",
    "version": "0.0.5",
    "project_urls": {
        "repository": "https://github.com/killiansheriff/NshellFinder"
    },
    "split_keywords": [
        "ovito",
        "python-modifier"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "1389f161538f90f6d9d1f0daa3cb7c7a8e472e1bebb858813888360f0e3dfcc2",
                "md5": "fc83d481799045cd75935f269c8574ac",
                "sha256": "3c3671886b274007073c42b198a2bf312d1eef3d4cf3a4499598bb8d3a001722"
            },
            "downloads": -1,
            "filename": "NshellFinder-0.0.5-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "fc83d481799045cd75935f269c8574ac",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.7",
            "size": 4788,
            "upload_time": "2024-03-13T23:23:59",
            "upload_time_iso_8601": "2024-03-13T23:23:59.795393Z",
            "url": "https://files.pythonhosted.org/packages/13/89/f161538f90f6d9d1f0daa3cb7c7a8e472e1bebb858813888360f0e3dfcc2/NshellFinder-0.0.5-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "6ae01f5f3f55e2306ea73abcaffd89e95953d05f6f105d9d416810f0e1039708",
                "md5": "edef901b8daf802ee02c17cd1e38b674",
                "sha256": "02b5fa023765f8c692e5e772277d134e241429b1f7209e392763a133bb109688"
            },
            "downloads": -1,
            "filename": "NshellFinder-0.0.5.tar.gz",
            "has_sig": false,
            "md5_digest": "edef901b8daf802ee02c17cd1e38b674",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.7",
            "size": 4423,
            "upload_time": "2024-03-13T23:24:01",
            "upload_time_iso_8601": "2024-03-13T23:24:01.979458Z",
            "url": "https://files.pythonhosted.org/packages/6a/e0/1f5f3f55e2306ea73abcaffd89e95953d05f6f105d9d416810f0e1039708/NshellFinder-0.0.5.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-03-13 23:24:01",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "killiansheriff",
    "github_project": "NshellFinder",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "nshellfinder"
}
        
Elapsed time: 0.21819s