gwresults
gwresults is a simple way to access parameter-estimation and search results from LVK catalogue publications and third-party community catalogues.
Posterior sample files are hosted on data repositories such as Zenodo, alongside their catalogue publication, and can be large (multi-GB). gwresults maintains a registry mapping event names to their Zenodo record, downloads files on demand, and caches them locally. A bundled table of summary statistics (median and highest-density interval per parameter) lets you query across events without downloading anything.
Install
$ pip install -e ".[test,docs]"
Usage
Command line:
$ gwresults get posterior --event GW150914_095045
Python:
import gwresults
path = gwresults.posterior.get("GW150914_095045")
Querying across events by summary statistics:
import astropy.units as u
from gwresults.fields import total_mass, waveform_approximant
results = gwresults.posterior.query(
total_mass >= 100 * u.solMass,
waveform_approximant == "SEOBNRv5PHM",
)
Adding events (maintainers)
No catalogue data is bundled yet. Events are added by generating a registry file from its Zenodo record, not by hand-writing one:
$ gwresults registry generate --zenodo-record 6513631 --catalogue GWTC-2.1
Wrote 54 entries to .../data/registry/gwtc-2.1.yaml (54 total).
This queries the Zenodo API for the record's real file list and
checksums and derives each event's gps_time from its name, so nothing
is hand-typed. See
src/gwresults/data/registry/README.md
(or the "Maintaining the registry" tutorial in the docs) for the full
workflow, including disambiguating records that bundle multiple files
per event.
Status
Early scaffold. Currently supports published parameter-estimation
posteriors only; search-pipeline results are planned but not yet
implemented (gwresults.search).
Development
$ pip install -e ".[test,docs]"
$ pytest
$ sphinx-build -b html docs docs/_build
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file gwresults-0.1.0.tar.gz.
File metadata
- Download URL: gwresults-0.1.0.tar.gz
- Upload date:
- Size: 36.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/6.1.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
7170331f1a746a8322fb591b9cbbba9d3cab2bd1fed03eff8d3b178ed4fd0a91
|
|
| MD5 |
3cb0fee15149ed1749fdb51de3ab3ae2
|
|
| BLAKE2b-256 |
26afac2edc23895be90d85a635f69b57e55a1e520fb83578bedb2c8620c62832
|
Provenance
The following attestation bundles were made for gwresults-0.1.0.tar.gz:
Publisher:
release.yml on transientlunatic/gwresults
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
gwresults-0.1.0.tar.gz -
Subject digest:
7170331f1a746a8322fb591b9cbbba9d3cab2bd1fed03eff8d3b178ed4fd0a91 - Sigstore transparency entry: 2280167980
- Sigstore integration time:
-
Permalink:
transientlunatic/gwresults@a698308b46437f81d04a8ef7728ede4c73b8fc40 -
Branch / Tag:
refs/tags/v0.1.0 - Owner: https://github.com/transientlunatic
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@a698308b46437f81d04a8ef7728ede4c73b8fc40 -
Trigger Event:
push
-
Statement type:
File details
Details for the file gwresults-0.1.0-py3-none-any.whl.
File metadata
- Download URL: gwresults-0.1.0-py3-none-any.whl
- Upload date:
- Size: 29.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/6.1.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
dda288cb85d0a1b2fff376b0b0de08dfa3869f346b2d1ae1c6abca2fb7561ef6
|
|
| MD5 |
d26fce84f196b9a4caff4179392acb6e
|
|
| BLAKE2b-256 |
d032d1d7377134ada657993588654436f936d2a6de76fa79ba23b631dde04aad
|
Provenance
The following attestation bundles were made for gwresults-0.1.0-py3-none-any.whl:
Publisher:
release.yml on transientlunatic/gwresults
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
gwresults-0.1.0-py3-none-any.whl -
Subject digest:
dda288cb85d0a1b2fff376b0b0de08dfa3869f346b2d1ae1c6abca2fb7561ef6 - Sigstore transparency entry: 2280168007
- Sigstore integration time:
-
Permalink:
transientlunatic/gwresults@a698308b46437f81d04a8ef7728ede4c73b8fc40 -
Branch / Tag:
refs/tags/v0.1.0 - Owner: https://github.com/transientlunatic
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@a698308b46437f81d04a8ef7728ede4c73b8fc40 -
Trigger Event:
push
-
Statement type:
