#!/usr/bin/env python

# Copyright (C) 2018 Collin Capano
#
# This program is free software; you can redistribute it and/or modify it
# under the terms of the GNU General Public License as published by the
# Free Software Foundation; either version 3 of the License, or (at your
# option) any later version.
#
# This program is distributed in the hope that it will be useful, but
# WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General
# Public License for more details.
#
# You should have received a copy of the GNU General Public License along
# with this program; if not, write to the Free Software Foundation, Inc.,
# 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.

"""Prints an RST table of available models from the inference.models
module.
"""
from pycbc.inference.sampler import samplers
from _dict_to_rst import (rst_dict_table, format_class)

tbl = rst_dict_table(samplers, key_format='``\'{0}\'``'.format,
                     header=('Name', 'Class'),
                     val_format=format_class)

filename = 'samplers-table.rst'
with open(filename, 'w') as fp:
    print(tbl, file=fp)