| Name | katsu JSON |
| Version |
0.1.0
JSON |
| download |
| home_page | None |
| Summary | Mueller calculus, polarimetry, and motion control |
| upload_time | 2024-10-30 17:10:26 |
| maintainer | None |
| docs_url | None |
| author | Jaren N. Ashcraft |
| requires_python | >=3.8 |
| license | The MIT License (MIT) Copyright (c) 2024 Jaren N. Ashcraft 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 |
python
optics
telescope
polarization
mueller
polarimetry
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Katsu: Integrated polarimetry and polarization simulation
[](https://codecov.io/gh/Jashcraf/katsu)
[](https://katsu.readthedocs.io/en/latest/?badge=latest)
[](https://joss.theoj.org/papers/82536dc5307fe34ddd929c89ed3d2575)
<img src="logo.png" alt="drawing" width="350"/>
Katsu is a Python 3.8+ library that contains an integrated library for modeling simple polarization effects (represented with Mueller calculus), simulating full stokes and mueller polarimetry, and integrating both of these as data reduction tools for conducting polarimetry in the laboratory. We also feature motion control routines for commercially available rotation stages for a more Pythonic interface to devices that would otherwise require serial communication.
## Documentation
The documentation can be found at [katsu.readthedocs.io](https://katsu.readthedocs.io/en/latest).
## Optional dependencies
Katsu has limited support for numpy-like backends, like `cupy` for accelerated computing and `jax` for automatic differentiation. These are not strict requirements, and must be installed by the user. To switch to them at runtime, either the `set_backend_to_cupy` or `set_backend_to_jax` method can be used from `katsu.math` at runtime.
## Features
- Mueller calculus
- Mueller data reduction
- Mueller polarimetry routines
- Motion control for the Agilis piezoelectric rotation stages
## Installation
Currently Katsu is installable from source, just run the following in your terminal
```
git clone https://github.com/Jashcraf/katsu/
cd katsu
pip install .
```
## Contributions / Questions
If you wish to contribute to Katsu, or have any questions about its use, please open an issue to start a discussion. Before a pull request is made, we prefer that an issue is made to discuss the contributions at a high level.
## Acknowledgements
Thanks to Quinn Jarecki of UA's Polarization Lab for the starting theory on dual rotating retarder mueller polarimetry, and for overall helpful discussions. Thanks also to William Melby, Manxuan Zhang, and Max Millar-Blanchaer for being the first to test out the Mueller data reduction code.
Raw data
{
"_id": null,
"home_page": null,
"name": "katsu",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "python, optics, telescope, polarization, mueller, polarimetry",
"author": "Jaren N. Ashcraft",
"author_email": "\"Jaren N. Ashcraft\" <jashcraft@arizona.edu>",
"download_url": "https://files.pythonhosted.org/packages/53/2b/c3b9377a1c9c190f0ba7f4478314c669a2f54a99afff16f1b09235706495/katsu-0.1.0.tar.gz",
"platform": "any",
"description": "# Katsu: Integrated polarimetry and polarization simulation\r\n[](https://codecov.io/gh/Jashcraf/katsu)\r\n[](https://katsu.readthedocs.io/en/latest/?badge=latest)\r\n[](https://joss.theoj.org/papers/82536dc5307fe34ddd929c89ed3d2575)\r\n\r\n<img src=\"logo.png\" alt=\"drawing\" width=\"350\"/>\r\n\r\nKatsu is a Python 3.8+ library that contains an integrated library for modeling simple polarization effects (represented with Mueller calculus), simulating full stokes and mueller polarimetry, and integrating both of these as data reduction tools for conducting polarimetry in the laboratory. We also feature motion control routines for commercially available rotation stages for a more Pythonic interface to devices that would otherwise require serial communication. \r\n\r\n## Documentation\r\nThe documentation can be found at [katsu.readthedocs.io](https://katsu.readthedocs.io/en/latest). \r\n\r\n## Optional dependencies\r\n\r\nKatsu has limited support for numpy-like backends, like `cupy` for accelerated computing and `jax` for automatic differentiation. These are not strict requirements, and must be installed by the user. To switch to them at runtime, either the `set_backend_to_cupy` or `set_backend_to_jax` method can be used from `katsu.math` at runtime.\r\n\r\n## Features\r\n\r\n- Mueller calculus\r\n- Mueller data reduction\r\n- Mueller polarimetry routines\r\n- Motion control for the Agilis piezoelectric rotation stages\r\n\r\n## Installation\r\nCurrently Katsu is installable from source, just run the following in your terminal\r\n```\r\ngit clone https://github.com/Jashcraf/katsu/\r\ncd katsu\r\npip install .\r\n```\r\n\r\n## Contributions / Questions\r\nIf you wish to contribute to Katsu, or have any questions about its use, please open an issue to start a discussion. Before a pull request is made, we prefer that an issue is made to discuss the contributions at a high level. \r\n\r\n## Acknowledgements\r\nThanks to Quinn Jarecki of UA's Polarization Lab for the starting theory on dual rotating retarder mueller polarimetry, and for overall helpful discussions. Thanks also to William Melby, Manxuan Zhang, and Max Millar-Blanchaer for being the first to test out the Mueller data reduction code.\r\n",
"bugtrack_url": null,
"license": "The MIT License (MIT) Copyright (c) 2024 Jaren N. Ashcraft 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": "Mueller calculus, polarimetry, and motion control",
"version": "0.1.0",
"project_urls": {
"Documentation": "https://katsu.readthedocs.org",
"GitHub": "https://github.com/jashcraf/katsu"
},
"split_keywords": [
"python",
" optics",
" telescope",
" polarization",
" mueller",
" polarimetry"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "766ac05b06adb0cd85dc2a5e3d6f2dd30059c0767b3bbf38c4ed6d3bb1552119",
"md5": "20b71b561b8f82a88de5d69cc1f60376",
"sha256": "63dc4c1ffdbbf07b6a06a9dc0c1509c3efb30e70ea745c927b93debfcfbdfa3d"
},
"downloads": -1,
"filename": "katsu-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "20b71b561b8f82a88de5d69cc1f60376",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 21573,
"upload_time": "2024-10-30T17:10:23",
"upload_time_iso_8601": "2024-10-30T17:10:23.274209Z",
"url": "https://files.pythonhosted.org/packages/76/6a/c05b06adb0cd85dc2a5e3d6f2dd30059c0767b3bbf38c4ed6d3bb1552119/katsu-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "532bc3b9377a1c9c190f0ba7f4478314c669a2f54a99afff16f1b09235706495",
"md5": "3752fd6f99710ae96fadba7fa5947e02",
"sha256": "eb4741753dc362a46c3cbd3b94332c2b8e1522a6fef222041d9f073b4ba6837e"
},
"downloads": -1,
"filename": "katsu-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "3752fd6f99710ae96fadba7fa5947e02",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 4002451,
"upload_time": "2024-10-30T17:10:26",
"upload_time_iso_8601": "2024-10-30T17:10:26.726496Z",
"url": "https://files.pythonhosted.org/packages/53/2b/c3b9377a1c9c190f0ba7f4478314c669a2f54a99afff16f1b09235706495/katsu-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-30 17:10:26",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "jashcraf",
"github_project": "katsu",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "katsu"
}
