diff --git a/docs/inference.rst b/docs/inference.rst index 1ace8055679..6de55c76cff 100644 --- a/docs/inference.rst +++ b/docs/inference.rst @@ -409,6 +409,17 @@ analysis. E.g. for an analysis using H1 only, the required options would be ``h1-transfer-function-a-pu``, ``h1-transfer-function-c``, ``h1-transfer-function-d``. +It is possible to generate calibration configuration files from the calibration +uncertainties estimates provided by the LIGO-Virgo-KAGRA collaboration. For +example, the LIGO and Virgo calibration uncertainty estimates for O1-O3 runs +can be downloaded from the following DCC link: +https://dcc.ligo.org/T2100313/public + +Once the calibration uncertainty files are downloaded in a local directory, the +calibration configuration files can be generated using the executable +``pycbc_inference_create_calibration_config``. See the section :ref:`Examples` +for the working example and run +``pycbc_inference_create_calibration_config --help`` for more details. ^^^^^^^^^^^ Constraints ^^^^^^^^^^^ @@ -509,6 +520,7 @@ Examples inference/examples/lisa_smbhb_inj_pe.rst inference/examples/sampler_platter.rst inference/models.rst + inference/examples/gw150914_calibration.rst ---------------------------- Visualizing the Posteriors diff --git a/docs/inference/examples/gw150914_calibration.rst b/docs/inference/examples/gw150914_calibration.rst new file mode 100644 index 00000000000..5a33abecce9 --- /dev/null +++ b/docs/inference/examples/gw150914_calibration.rst @@ -0,0 +1,44 @@ +------------------------------------------------------------------------ +GW150914 example with gaussian noise model and calibration configuration +------------------------------------------------------------------------ + +To run on GW150914 with detector calibration, we can use the same +:download:`sampler +<../../../examples/inference/samplers/emcee_pt-gw150914_like.ini>`, :download: +`prior +and model <../../../examples/inference/priors/gw150914_like.ini>` configuration + files as was :ref:`used for the simulated BBH example`. + We only need to change the data configuration file, so that we will run on real gravitational-wave data. + +First, we need to download the data from the `Gravitational Wave Open Science +Center `_. Run: + + .. code-block:: bash + + wget https://www.gwosc.org/eventapi/html/GWTC-1-confident/GW150914/v3/H-H1_GWOSC_16KHZ_R1-1126257415-4096.gwf + wget https://www.gwosc.org/eventapi/html/GWTC-1-confident/GW150914/v3/L-L1_GWOSC_16KHZ_R1-1126257415-4096.gwf + +This will download the appropriate data ("frame") files to your current working +directory. You can now use the following data configuration file: + +.. literalinclude:: ../../../examples/inference/gw150914/data.ini + :language: ini + +:download:`Download <../../../examples/inference/gw150914/data.ini>` + +The ``frame-files`` argument points to the data files that we just downloaded +from GWOSC. If you downloaded the files to a different directory, modify this +argument accordingly to point to the correct location. + +.. note:: + If you are running on a cluster that has a ``LIGO_DATAFIND_SERVER`` (e.g., + LIGO Data Grid clusters, Atlas) you do not need to copy frame + files. Instead, replace the ``frame-files`` argument with ``frame-type``, + and set it to ``H1:H1_LOSC_16_V1 L1:L1_LOSC_16_V1``. + +Now run: + +.. literalinclude:: ../../../examples/inference/gw150914/run.sh + :language: bash + +:download:`Download <../../../examples/inference/gw150914/run.sh>`