# 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 psd models.
"""
from __future__ import (print_function, absolute_import)
from pycbc import psd
from _dict_to_rst import (rst_dict_table, format_function)
psds = {
p: getattr(psd.analytical, p)
for p in psd.analytical.get_psd_model_list()
}
tbl = rst_dict_table(psds,
key_format='``{0}``'.format,
header=('Name', 'Function'),
val_format=format_function)
filename = 'psd_models-table.rst'
with open(filename, 'w') as fp:
print(tbl, file=fp)
# 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 __future__ import (print_function, absolute_import)
from pycbc.inference.models import models
from _dict_to_rst import (rst_dict_table, format_class)
tbl = rst_dict_table(models, key_format='``\'{0}\'``'.format,
header=('Name', 'Class'),
val_format=format_class)
filename = 'models-table.rst'
with open(filename, 'w') as fp:
print(tbl, file=fp)
# Copyright (C) 2018 Duncan Macleod, 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 distributions from the distributions
module.
"""
from __future__ import (print_function, absolute_import)
from pycbc.transforms import transforms
from _dict_to_rst import (rst_dict_table, format_class)
tbl = rst_dict_table(transforms,
key_format='``\'{0}\'``'.format,
header=('Name', 'Class'),
val_format=format_class)
filename = 'transforms-table.rst'
with open(filename, 'w') as fp:
print(tbl, file=fp)
# 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.models import get_models
from _dict_to_rst import (rst_dict_table, format_class)
tbl = rst_dict_table(get_models(), key_format='``\'{0}\'``'.format,
header=('Name', 'Class'),
val_format=format_class)
filename = 'models-table.rst'
with open(filename, 'w') as fp:
print(tbl, file=fp)
# 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 the usable waveform parameters as a RST table.
"""
# NOTE: the manual call to OrdereDict can be removed in favour of
# `ParameterList.description_dict` when gwastro/pycbc#2125 is merged
# and released
from __future__ import (print_function, absolute_import)
from pycbc import waveform
from _dict_to_rst import rst_dict_table
allparams = (waveform.td_waveform_params + waveform.fd_waveform_params +
waveform.location_params)
tbl = rst_dict_table(allparams.description_dict,
key_format='``\'{0}\'``'.format,
header=('Parameter', 'Description'),
sort=False)
filename = 'waveform-parameters.rst'
with open(filename, 'w') as fp:
print(tbl, file=fp)
# 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 the usable waveform parameters as a RST table.
"""
# NOTE: the manual call to OrdereDict can be removed in favour of
# `ParameterList.description_dict` when gwastro/pycbc#2125 is merged
# and released
from __future__ import (print_function, absolute_import)
from pycbc import waveform
from _dict_to_rst import rst_dict_table
allparams = (waveform.td_waveform_params +
waveform.fd_waveform_params +
waveform.location_params)
tbl = rst_dict_table(allparams.description_dict,
key_format='``\'{0}\'``'.format,
header=('Parameter', 'Description'),
sort=False)
filename = 'waveform-parameters.rst'
with open(filename, 'w') as fp:
print(tbl, file=fp)