| Name | pyxc JSON |
| Version |
0.0.2
JSON |
| download |
| home_page | |
| Summary | Python point-to-point correlation library. |
| upload_time | 2023-09-10 21:02:55 |
| maintainer | Sang-Hyeok Lee |
| docs_url | None |
| author | Sang-Hyeok Lee, Mattis Seehaus |
| requires_python | >=3.10 |
| license | MIT License Copyright (c) 2023 S. Lee, M. Seehaus Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
point-to-point
correlation
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# XCorrelate: 2-dimensional correlation library.
[](https://pyxc.readthedocs.io/en/latest/?badge=latest)
[](https://github.com/psf/black)
[](https://doi.org/10.5281/zenodo.8322342)
## About PyXC
PyXC is a point-to-point correlation tool based on Python. This library aims for a self-documenting correlation library on top of the IPython environment.
Please refer the following link for the documentation: [Read the docs](https://pyxc.readthedocs.io/en/latest/).
## Install
```bash
pip install pyxc
```
## Requirement
- Python 3.10 or higher
- Numpy
- Scipy
## Functionality
- Point-to-point correlation. For example:
- Correlation between EBSD and optical microscopy.
- Correlation between EBSD and nano-indentation grid.
Raw data
{
"_id": null,
"home_page": "",
"name": "pyxc",
"maintainer": "Sang-Hyeok Lee",
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": "",
"keywords": "Point-to-point correlation",
"author": "Sang-Hyeok Lee, Mattis Seehaus",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/3e/5c/8c8c0af6a8dd262494c177b78e58671c792348f800384ce45c8b02b5a828/pyxc-0.0.2.tar.gz",
"platform": null,
"description": "# XCorrelate: 2-dimensional correlation library.\n\n[](https://pyxc.readthedocs.io/en/latest/?badge=latest)\n[](https://github.com/psf/black)\n[](https://doi.org/10.5281/zenodo.8322342)\n\n## About PyXC\n\nPyXC is a point-to-point correlation tool based on Python. This library aims for a self-documenting correlation library on top of the IPython environment.\n\nPlease refer the following link for the documentation: [Read the docs](https://pyxc.readthedocs.io/en/latest/).\n\n## Install\n```bash\npip install pyxc\n``` \n## Requirement\n- Python 3.10 or higher\n- Numpy\n- Scipy\n\n## Functionality\n- Point-to-point correlation. For example:\n - Correlation between EBSD and optical microscopy.\n - Correlation between EBSD and nano-indentation grid.\n \n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2023 S. Lee, M. Seehaus Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
"summary": "Python point-to-point correlation library.",
"version": "0.0.2",
"project_urls": {
"Documentation": "https://pyxc.readthedocs.org",
"Homepage": "https://github.com/polarities/PyXC",
"Repository": "https://github.com/polarities/PyXC.git"
},
"split_keywords": [
"point-to-point",
"correlation"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e33de9d7edc45aae86c184c9366c740bde638dcdfbe40c5ab06be6f7959a35c3",
"md5": "331412958af06b478e1942719bb17f91",
"sha256": "e2c56d4cb0b6dacf702e59dd9d9caef63d0f770fc366f474bd4511143530b0b8"
},
"downloads": -1,
"filename": "pyxc-0.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "331412958af06b478e1942719bb17f91",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 22701,
"upload_time": "2023-09-10T21:02:54",
"upload_time_iso_8601": "2023-09-10T21:02:54.033589Z",
"url": "https://files.pythonhosted.org/packages/e3/3d/e9d7edc45aae86c184c9366c740bde638dcdfbe40c5ab06be6f7959a35c3/pyxc-0.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "3e5c8c8c0af6a8dd262494c177b78e58671c792348f800384ce45c8b02b5a828",
"md5": "dae5b0f9b8e2c979318d12dacf10b2f2",
"sha256": "c07ab6033c11a58cee9346a7e236d6d14e3e4cd769af43ebce33815916167284"
},
"downloads": -1,
"filename": "pyxc-0.0.2.tar.gz",
"has_sig": false,
"md5_digest": "dae5b0f9b8e2c979318d12dacf10b2f2",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 19615,
"upload_time": "2023-09-10T21:02:55",
"upload_time_iso_8601": "2023-09-10T21:02:55.591470Z",
"url": "https://files.pythonhosted.org/packages/3e/5c/8c8c0af6a8dd262494c177b78e58671c792348f800384ce45c8b02b5a828/pyxc-0.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-09-10 21:02:55",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "polarities",
"github_project": "PyXC",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "pyxc"
}
