Skip to main content
priwo: I/O for common pulsar data formats.

License Version Python versions

Tests Documentation Status Interrogate

Stars Downloads Issues

Gitmoji Code style: black

What is this?

priwo is a library that allows you to read in and write out pulsar data from the following data formats:

  • SIGPROC headers,
  • PRESTO FFT (*.fft) files,
  • PRESTO infodata (*.inf) files,
  • PRESTO folded data (*.pfd) files,
  • PRESTO time series (*.dat) files,
  • SIGPROC filterbank (*.fil) files,
  • SIGPROC time series (*.tim) files,
  • PRESTO best pulse profile (*.bestprof) files,
  • TEMPO polynomial ephemerides (*.polycos) files.

priwo's API is deliberately low-level: each function in priwo deals with a single file format and takes/returns a Python dictionary. This allows users to design arbitrary high-level APIs on top of priwo's functionality. This is unlike most other contemporary libraries, such as your. your (to which this library has been frequently compared to) provides a high-level API for reading in pulsar data, while also providing modules to help process and analyze it. This is makes the number of dependencies it uses is a bit high (as of 05/10/22, that is a total of 9 dependencies). On the other hand, priwo has just a single dependency: pabo1. This makes it an ideal choice to drop into your projects, without worrying about dependency hell.

priwo is well-tested (via ward) and actively maintained. No major changes to the API are expected before v0.1.0. Support for many more formats, such as PSRFITS, is on the way. If you would like to contribute, have a look at CONTRIBUTING.md, and get in touch! If you find a bug, feel free to open an issue. If you would like to suggest support for any data format(s) I have missed, suggest a feature, or just chat, feel free to jump into the discussions.

Installing

Installing priwo is as easy as:

pip install priwo

  1. pabo is a package I made to make parsing binary data easier, and it has just two dependencies : attrs and numpy. ↩

Metadata

Release files for priwo 0.0.3

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for priwo 0.0.3
File Size Uploaded Provenance Actions
priwo-0.0.3.tar.gz 43.7 MB Without provenance Details for priwo-0.0.3.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for priwo 0.0.3
File Interpreter ABI Platform Actions
priwo-0.0.3-py3-none-any.whl Python 3 none any Details for priwo-0.0.3-py3-none-any.whl

Total release size: 43.7 MB

Release files / priwo-0.0.3.tar.gz

Download URL priwo-0.0.3.tar.gz
Size 43.7 MB
Tags Source
SHA-256 checksum
How to use checksums
5d7b8e7a9c49e8e370b8b8b2831d71090763e35372ebbf28647b7a7fd6b11f0f
BLAKE2b-256 checksum
How to use checksums
ae007d74a7844d90a4832c037da07647083cb04c4825f2a0761e272ffd19fcbd
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.1 CPython/3.11.4

Release files / priwo-0.0.3-py3-none-any.whl

Download URL priwo-0.0.3-py3-none-any.whl
Size 14.5 kB
Tags Python 3
SHA-256 checksum
How to use checksums
69b8c8c0546785c09dc20c70d48bd60aba0ad007079c25bff90afbbcff6b3f58
BLAKE2b-256 checksum
How to use checksums
f75a7cc2a4e9f7a7e663b184aba0b408b54b6b18e72b902e1c91cb3c84e6687c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.1 CPython/3.11.4

Security for priwo 0.0.3

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