Science Score: 75.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
✓CITATION.cff file
Found CITATION.cff file -
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
✓DOI references
Found 3 DOI reference(s) in README -
✓Academic publication links
Links to: zenodo.org -
○Academic email domains
-
✓Institutional organization owner
Organization punch-mission has institutional domain (punch.space.swri.edu) -
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (13.9%) to scientific vocabulary
Keywords
Repository
A solar polarization resolver.
Basic Info
- Host: GitHub
- Owner: punch-mission
- License: other
- Language: Python
- Default Branch: main
- Homepage: https://solpolpy.readthedocs.io/en/latest/
- Size: 91.6 MB
Statistics
- Stars: 5
- Watchers: 2
- Forks: 0
- Open Issues: 6
- Releases: 14
Topics
Metadata Files
README.md
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 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.
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
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.
Owner
- Name: PUNCH Mission
- Login: punch-mission
- Kind: organization
- Website: https://punch.space.swri.edu/
- Repositories: 4
- Profile: https://github.com/punch-mission
a NASA mission to study the solar wind
Citation (CITATION.cff)
cff-version: 1.2.0 message: "If you use this software, please cite it as below." authors: - family-names: "Hughes" given-names: "J. Marcus" orcid: "https://orcid.org/0000-0003-3410-7650" - family-names: "Patel" given-names: "Ritesh" orcid: "https://orcid.org/0000-0001-8504-2725" - family-names: "West" given-names: "Matthew" orcid: "https://orcid.org/0000-0002-0631-2393" - family-names: "DeForest" given-names: "Craig" orcid: "https://orcid.org/0000-0002-7164-2786" - family-names: "Kovak" given-names: "Sarah" orcid: "https://orcid.org/0000-0003-1714-5970" - family-names: "Lamb" given-names: "Derek" orcid: "https://orcid.org/0000-0002-6061-6443" - family-names: "Lowder" given-names: "Chris" orcid: "https://orcid.org/0000-0001-8318-8229" - family-names: "Seaton" given-names: "Daniel" orcid: "https://orcid.org/0000-0002-0494-2025" - family-names: "Walbridge" given-names: "Bryce" title: "solpolpy" version: 0.4.1 doi: 10.5281/zenodo.10076326 date-released: 2025-07-22 url: "https://github.com/punch-mission/solpolpy"
GitHub Events
Total
- Create event: 25
- Release event: 5
- Issues event: 12
- Watch event: 2
- Delete event: 23
- Issue comment event: 29
- Push event: 83
- Pull request review comment event: 7
- Pull request review event: 11
- Pull request event: 45
Last Year
- Create event: 25
- Release event: 5
- Issues event: 12
- Watch event: 2
- Delete event: 23
- Issue comment event: 29
- Push event: 83
- Pull request review comment event: 7
- Pull request review event: 11
- Pull request event: 45
Issues and Pull Requests
Last synced: 6 months ago
All Time
- Total issues: 5
- Total pull requests: 12
- Average time to close issues: over 1 year
- Average time to close pull requests: 4 days
- Total issue authors: 2
- Total pull request authors: 3
- Average comments per issue: 0.2
- Average comments per pull request: 1.17
- Merged pull requests: 10
- Bot issues: 0
- Bot pull requests: 2
Past Year
- Issues: 1
- Pull requests: 12
- Average time to close issues: N/A
- Average time to close pull requests: 4 days
- Issue authors: 1
- Pull request authors: 3
- Average comments per issue: 0.0
- Average comments per pull request: 1.17
- Merged pull requests: 10
- Bot issues: 0
- Bot pull requests: 2
Top Authors
Issue Authors
- jmbhughes (16)
- s0larish (2)
- lowderchris (1)
- pre-commit-ci[bot] (1)
Pull Request Authors
- pre-commit-ci[bot] (42)
- jmbhughes (22)
- s0larish (7)
- github-actions[bot] (4)
- dependabot[bot] (3)
- lowderchris (2)
Top Labels
Issue Labels
Pull Request Labels
Packages
- Total packages: 1
-
Total downloads:
- pypi 1,806 last-month
- Total dependent packages: 0
- Total dependent repositories: 0
- Total versions: 14
- Total maintainers: 1
pypi.org: solpolpy
Solar polarization resolver for any instrument
- Documentation: https://solpolpy.readthedocs.io/
- License: MIT License
-
Latest release: 0.5.0
published 6 months ago
Rankings
Maintainers (1)
Dependencies
- actions/checkout v3 composite
- actions/setup-python v3 composite
- codecov/codecov-action v3 composite
- actions/checkout v2 composite
- actions/setup-python v2 composite
- peaceiris/actions-gh-pages v3.6.1 composite
- jupyter-book *
- matplotlib *
- numpy *
- astropy *
- matplotlib *
- ndcube *
- networkx *
- numpy *
- sunpy *
- actions/checkout v3 composite
- actions/setup-python v3 composite
- pypa/gh-action-pypi-publish 27b31702a0e7fc50959f5ad993c78deac1bdfc29 composite
- astropy *
- matplotlib *
- ndcube *
- networkx *
- numpy *
- sunpy *
- astropy * development
- coverage * development
- matplotlib * development
- ndcube * development
- networkx * development
- numpy * development
- pre-commit * development
- pytest * development
- pytest-cov * development
- ruff * development
- sunpy * development