solpolpy 0.4.0

Solar polarization resolver for any instrument

solpolpy

solpolpy is a solar polarization resolver based on Deforest et al. 2022. It converts between various polarization formats, e.g. from the native three triple version from observations (also known as the MZP convention) to polarization brightness (pB) and total polarization (B), Stokes I, Q and U, etc. As it is in early development, breaking changes may be frequent.

An example of transforming the polarization basis using the LASCO/C2 images is shown in the image below. The images at polarizing angles of -60°, 0° and +60° is shown in the top panel as Bm, Bz and Bp respectively. The bottom panel shows the output of the solpolpy to convert the initial basis to the Stokes I, Q and U.

Quickstart

pip install solpolpy

We recommend following along the examples in the documentation!

Getting Help

Please open a discussion or issue for help.

Features Coming Soon

• core transformation capability
• clearer examples in the documentation
• more comprehensive support for 4-polarizer systems
• functions to deal with the IMAX effect in wide-field imagers
• quantification and propagation of error
• additional plotting utilities

Contributing

We encourage all contributions. If you have a problem with the code or would like to see a new feature, please open an issue. Or you can submit a pull request.

If you're contributing code, please see this package's deveopment guide.

Code of Conduct

Access here

Citing

To cite the software please cite the version you used with the Zenodo citation.

Origin of the Name

solpolpy is just a combination of sol for solar, pol for polarization, and py for Python.