module.yaml

# Module description

name: gwem
version: 1.0
purpose: Likelihood analysis for cosmological measurements with standard sirens
url: "https://github.com/SSantosLab/gw"
interface: gwem.py
attribution: []
rules: 
    "Likelihood analysis code originally intended for use in DES and LSST DESC. 
    Feel free to clone or fork the repository to use or modify the code. 
    Send a pull request if you wish to contribute your modifications. 
    Contact us via github issues with problems, feedback.  
    "

cite:
    - "arXiv:XXXX.XXXXXX"

assumptions:
    - "EM sources have a probability of association with the GW sources."
    - "Distances determined from the GW data marginalizing over all other astrophysical parameters."
    - "Redshifts are obtained from spectroscopy of the host galaxies."
    - "Peculiar velocity corrections are applied and treated as systematic uncertainties."

explanation: |
    "The era of multi-messenger cosmology started with the neutron star merger GW170817.
    We incorporate this new cosmological probe into the cosmosis framework. 
    The measurement is based on the distance-redshift relation. 
    "

# List of parameters that can go in the params.ini file in the section for this module    

params:
    file: Path to gwem.py, the interface file
    data_dir: Path to directory containing the data files
    data_file: Name of the data file

#Inputs for a given choice of a parameter, from the values.ini or from other modules

inputs:
    distances:
        dl: Double vector of luminosity distances
        z: Double vector of redshifts

outputs:
    likelihoods:
        GWEM_LIKE: Log-likelihood from the data
    data_vector:
        GWEM_THEORY: Theoretical prediction values for dl
        GWEM_INVERSE_COVARIANCE: Inverse of covariance matrix