PolPy

polpy is a universal tool developed to analyse high-energy polarization data from scattering polarimeters. Based on 3ML, it is a generalization of the polarpy (Burgess, Kole et al. 2019, A&A) tool that was developed for POLAR analysis. It can be used for current and future scattering polarimeters, provided standardized data and response format (docs/Data_and_Response_Format_For_PolPy.pdf) and a defined coordinate convention are followed (docs/Coordinate_Defintions_and_Transforms_For_PolPy.pdf). .

Installation
Package layout
Quick start
Data and response file formats
Citing
License
Authors

Installation

polpy is available on PyPI and uses modern Python packaging via pyproject.toml. We recommend installing it inside a virtual environment (using conda, venv, or your preferred environment manager) to prevent dependency conflicts.

Standard Installation

To install the latest stable version directly from PyPI, run:

pip install polpy

Package layout

polpy/
├── polpy/
│   ├── poldata.py            # PolData: read raw polarization event files, compute PA offset
│   ├── polresponse.py        # PolResponse: read + interpolate the polarization response
│   └── polarizationlike.py   # PolarizationLike: the 3ML plugin (likelihood, fitting, display)
├── docs/
│   ├── Data_and_Response_Format_For_PolPy.pdf
│   └── Coordinate_Defintions_and_Transforms_For_PolPy.pdf
├── examples/
│   ├── example.py                 # loading and corner-plotting saved fit results
│   ├── polar_GRB170114A.py        # full joint POLAR + Fermi/GBM spectro-polarimetric fit
│   └── verify_czti_pol_fit.py     # cross-check of CZTI polarization fit against direct simulation
└── tests/                    # pytest unit tests

Data and response file formats

Two reference documents ship with the repo:

docs/Data_and_Response_Format_For_PolPy.pdf — layout of the POLEVENTS event FITS extension and the .prsp response FITS extensions (INEBOUNDS, SABOUNDS, INPAVALS, SPECRESP POLMATRIX, SPECRESP UNPOLMATRIX)
docs/Coordinate_Defintions_and_Transforms_For_PolPy.pdf — instrument reference frame, local-tangent-plane frame, and the IAU polarization-angle offset convention used by PolData.get_pa_offset()

License

GPL-3.0.

Authors

Sujay Mate, Hancheng Li, Utkarsh Pathak, Yashowardhan Rai, Nicholas De Angelis, Merlin Kole, Varun Bhalerao.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

polpy-1.0.0.tar.gz (19.5 kB view details)

Uploaded Aug 7, 2026 Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

The dropdown lists show the available interpreters, ABIs, and platforms. Enable javascript to be able to filter the list of wheel files.

polpy-1.0.0-py3-none-any.whl (21.2 kB view details)

Uploaded Aug 7, 2026 Python 3

File details

Details for the file polpy-1.0.0.tar.gz.

File metadata

Download URL: polpy-1.0.0.tar.gz
Upload date: Aug 7, 2026
Size: 19.5 kB
Tags: Source
Uploaded using Trusted Publishing? Yes
Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for polpy-1.0.0.tar.gz
Algorithm	Hash digest
SHA256	`0ecb94eccc3b9675aa42b98b794a9cfe1dfb9704f1890a860e1be2dce693320c`
MD5	`d8d2917b5183f68767e13533b4d48191`
BLAKE2b-256	`fcce5c121a669d91dd331c901135865ad05371d6135662e481c0e7426779492b`

See more details on using hashes here.

Provenance

The following attestation bundles were made for polpy-1.0.0.tar.gz:

Publisher: deploy.yml on threeML/polpy

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Statement:
- Statement type: https://in-toto.io/Statement/v1
- Predicate type: https://docs.pypi.org/attestations/publish/v1
- Subject name: polpy-1.0.0.tar.gz
- Subject digest: 0ecb94eccc3b9675aa42b98b794a9cfe1dfb9704f1890a860e1be2dce693320c
- Sigstore transparency entry: 2366722357
- Sigstore integration time: Aug 7, 2026
Source repository:
- Permalink: threeML/polpy@f1c30ee95cda5c05846ce0ed5d4df92bd995d78f
- Branch / Tag: refs/tags/v1.0.0
- Owner: https://github.com/threeML
- Access: public
Publication detail:
- Token Issuer: https://token.actions.githubusercontent.com
- Runner Environment: github-hosted
- Publication workflow: deploy.yml@f1c30ee95cda5c05846ce0ed5d4df92bd995d78f
- Trigger Event: push