def write_about_page(configfile, prog=None):
"""Write a page explaining how an hveto analysis was completed
Parameters
----------
ifo : `str`
the prefix of the interferometer used in this analysis
start : `int`
the GPS start time of the analysis
end : `int`
the GPS end time of the analysis
configfile : `str`
the path of the configuration file to embed
prog : `str`, optional
name of the program which produced this page, defaults to
the script run on the command-line
outdir : `str`, optional
the output directory for the HTML
Returns
-------
index : `str`
the path of the HTML written for this analysis
"""
return gwhtml.about_this_page(configfile, prog=prog)
def write_about_page(configfile):
"""Write a page explaining how an hveto analysis was completed
Parameters
----------
ifo : `str`
the prefix of the interferometer used in this analysis
start : `int`
the GPS start time of the analysis
end : `int`
the GPS end time of the analysis
configfile : `str`
the path of the configuration file to embed
outdir : `str`, optional
the output directory for the HTML
Returns
-------
index : `str`
the path of the HTML written for this analysis
"""
return gwhtml.about_this_page(configfile)
def write_about_page(configfile):
"""Write a page explaining how an hveto analysis was completed
Parameters
----------
ifo : `str`
the prefix of the interferometer used in this analysis
start : `int`
the GPS start time of the analysis
end : `int`
the GPS end time of the analysis
configfile : `str`
the path of the configuration file to embed
outdir : `str`, optional
the output directory for the HTML
Returns
-------
index : `str`
the path of the HTML written for this analysis
"""
# set up page
page = gwhtml.about_this_page(configfile)
return page
def write_html(self, config=list(), prog=None, **kwargs):
return super(AboutTab, self).write_html(
html.about_this_page(config=config, prog=prog), **kwargs)
def write_html(self, config=list(), **kwargs):
return super(AboutTab, self).write_html(
html.about_this_page(config=config), **kwargs)