Skip to main content

solpolpy

codecov CI PyPI version DOI

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 brightness (tB), 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

Quickstart

pip install solpolpy

We recommend following along the examples in the documentation!

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.

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.

Metadata

Release files for solpolpy 0.8.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 solpolpy 0.8.0
File Size Uploaded Provenance Actions
solpolpy-0.8.0.tar.gz 22.8 MB Without provenance Details for solpolpy-0.8.0.tar.gz

Release files / solpolpy-0.8.0.tar.gz

Download URL solpolpy-0.8.0.tar.gz
Size 22.8 MB
Tags Source
SHA-256 checksum
How to use checksums
7a49ae18efdc98b600ae6678dbf079d0ae5ed3ca027f044c53e49fa0e46f29e5
BLAKE2b-256 checksum
How to use checksums
6ec0bdd975f0e36085394e50a5766f943eff22f1c5f1c115030bf6cab42e0b6d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.9.25

Security for solpolpy 0.8.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.

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