Data release

2. Data release#

This page describes the two parts of the data release, their contents and how to downloaded.

2.1. Code release#

The code for reproducing the figures and performing the analyses are available in a Zenodo record and on GitHub.

The GitHub repository can be clone by running:

git clone git@github.com:mj-will/gw-smc.git

Alternatively, the Zenodo record can be downloaded directly or using command line tools such as zenodo_get.

Structure#

The code release contains the following directories:

  • data_release: scripts for preparing and downloading the data releases

  • gwtc_data_release: scripts for download relevant files from the GWTC-2.1 and GWTC-3 data releases

  • experiments: scripts for performing the analyses

  • plotting: scripts and notebooks for reproducing the figures and tables in the paper

  • src: the source code for the gw_smc_utils packages that contains common functions used in the different analyses and plotting

  • docs: the code for producing the data release page

and some additional files for building the gw_smc_utils package and managing the repository.

2.2. Results and data#

The results and data are available in a separate Zenodo record. We recommend downloading this using the scripts provided in the data_release directory the code data release.

Structure#

The data release is divided into three parts:

  • Core results (gw_smc_data_release_core): this contains the only data necessary to reproduce the figures and tables in the paper

  • Additional results (gw_smc_data_release_additional_results): this contains additional results that are not needed to reproduce the figures. These include the bilby result file for each analysis which contain the posterior samples, run statistics and log-evidence,

  • Data (gw_smc_data_release_data): this includes the data files for the binary black hole analyses

Downloading the data release#

Note

This requires having zenodo_get installed which is included in the provided environment

Warning

These commands will be implemented once the data release is public.

The included Makefile allows you to either download the entire release or only a fraction using the

  • make download_core: download only the core results need to reproduce the figures and table

  • make download_additional: download the additional results such as bilby result files

  • make download_data: download the injection data used for the BBH analyses

  • make download_all: download the entire release.

Important

The entire data release is several GBs and may take while to download.

Contents