https://github.com/punch-mission/solpolpy

A solar polarization resolver.
https://github.com/punch-mission/solpolpy

astronomy-astrophysics data-analysis polarization-data polarization-imaging punch solar

Last synced: about 1 month ago
JSON representation

A solar polarization resolver.

• Host: GitHub
• URL: https://github.com/punch-mission/solpolpy
• Owner: punch-mission
• License: other
• Created: 2022-06-01T15:51:54.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2025-11-14T21:14:33.000Z (2 months ago)
• Last Synced: 2025-11-14T22:07:01.320Z (2 months ago)
• Topics: astronomy-astrophysics, data-analysis, polarization-data, polarization-imaging, punch, solar
• Language: Python
• Homepage: https://solpolpy.readthedocs.io/en/latest/
• Size: 91.6 MB
• Stars: 5
• Watchers: 2
• Forks: 0
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.rst
  • License: LICENSE.txt
  • Code of conduct: CODE_OF_CONDUCT.md
  • Citation: CITATION.cff

Awesome Lists containing this project

README

          
# solpolpy

[![codecov](https://codecov.io/gh/punch-mission/solpolpy/branch/main/graph/badge.svg?token=835TUH7CKI)](https://codecov.io/gh/punch-mission/solpolpy)

[![CI](https://github.com/punch-mission/solpolpy/actions/workflows/CI.yml/badge.svg)](https://github.com/punch-mission/solpolpy/actions/workflows/CI.yml)

[![PyPI version](https://badge.fury.io/py/solpolpy.svg)](https://badge.fury.io/py/solpolpy)

[![DOI](https://zenodo.org/badge/498801276.svg)](https://zenodo.org/doi/10.5281/zenodo.10076326)

`solpolpy` is a solar polarization resolver based on [Deforest et al. 2022](https://doi.org/10.3847/1538-4357/ac43b6).

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 brightness (B), Stokes I, Q and U, etc.

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.

![Example result image](eg_image.png)

## Quickstart

`pip install solpolpy`

We recommend following along the examples in [the documentation](https://solpolpy.readthedocs.io/en/latest/quickstart.html)!

## Getting Help

Please open a discussion or issue for help.

## 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](https://solpolpy.readthedocs.io/en/latest/development.html).

## Code of Conduct

[Access here](CODE_OF_CONDUCT.md)

## Citing

To cite the software please cite the version you used with [the Zenodo citation](https://zenodo.org/records/10289143).

## Origin of the Name

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