Skip to main content

Katsu: Integrated polarimetry and polarization simulation

codecov Documentation Status status

drawing

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.

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.

Metadata

Release files for katsu 0.1.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for katsu 0.1.0
File Size Uploaded Provenance Actions
katsu-0.1.0.tar.gz 4.0 MB Without provenance Details for katsu-0.1.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for katsu 0.1.0
File Interpreter ABI Platform Actions
katsu-0.1.0-py3-none-any.whl Python 3 none any Details for katsu-0.1.0-py3-none-any.whl

Total release size: 4.0 MB

Release files / katsu-0.1.0.tar.gz

Download URL katsu-0.1.0.tar.gz
Size 4.0 MB
Tags Source
SHA-256 checksum
How to use checksums
eb4741753dc362a46c3cbd3b94332c2b8e1522a6fef222041d9f073b4ba6837e
BLAKE2b-256 checksum
How to use checksums
532bc3b9377a1c9c190f0ba7f4478314c669a2f54a99afff16f1b09235706495
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.1.1 CPython/3.12.4

Release files / katsu-0.1.0-py3-none-any.whl

Download URL katsu-0.1.0-py3-none-any.whl
Size 21.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
63dc4c1ffdbbf07b6a06a9dc0c1509c3efb30e70ea745c927b93debfcfbdfa3d
BLAKE2b-256 checksum
How to use checksums
766ac05b06adb0cd85dc2a5e3d6f2dd30059c0767b3bbf38c4ed6d3bb1552119
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.1.1 CPython/3.12.4

Security for katsu 0.1.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.1.0 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page