hveto.html module

HTML utilities for hveto

hveto.html.banner(ifo, start, end)

Initialise a new markup banner

Parameters:

ifostr

the interferometer prefix

startint

the GPS start time of the analysis

endint

the GPS end time of the analysis

Returns:

pagemarkup.page

the structured markup to open an HTML document

hveto.html.bold_param(key, value, **attrs)

Write a (key, value) pair in HTML as <p><b>key</b>: value</p>

Parameters:

keystr

the element to be rendered in bold

valuestr

the explanation/description of the key

**attrs

HTML attributes for the containing <p> tag

Returns:

htmlstr

hveto.html.navbar(ifo, gpstime, winners=[])

Initialise a new markup.page

Parameters:

ifostr

the interferometer prefix

gpstimefloat

the central GPS time of the analysis

winnerslist

list of round winners for navbar table of contents

Returns:

pagemarkup.page

the structured markup to open an HTML document

hveto.html.wrap_html(func)

Decorator to wrap a function with init_page and close_page calls

This allows inner HTML methods to be written with minimal arguments and content, hopefully making things simpler

hveto.html.write_about_page(configfile, prog=None)

Write a page explaining how an hveto analysis was completed

Parameters:

ifostr

the prefix of the interferometer used in this analysis

startint

the GPS start time of the analysis

endint

the GPS end time of the analysis

configfilestr

the path of the configuration file to embed

progstr, optional

name of the program which produced this page, defaults to the script run on the command-line

outdirstr, optional

the output directory for the HTML

Returns:

indexstr

the path of the HTML written for this analysis

hveto.html.write_hveto_page(rounds, plots, context='default')

Write the Hveto results to HTML

Parameters:

ifostr

the prefix of the interferometer used in this analysis

startint

the GPS start time of the analysis

endint

the GPS end time of the analysis

roundslist of HvetoRound

the rounds produced by this analysis

plotslist of str

the list of summary plots

outdirstr, optional

the output directory for the HTML

winnerslist of str, optional

list of channels that won each round

contextstr, optional

the bootstrap context class for this result, see the bootstrap docs for more details

Returns:

indexstr

the path of the HTML written for this analysis

hveto.html.write_null_page(reason, context='info')

Write the Hveto results to HTML

Parameters:

ifostr

the prefix of the interferometer used in this analysis

startint

the GPS start time of the analysis

endint

the GPS end time of the analysis

reasonstr

the explanation for this null result

contextstr, optional

the bootstrap context class for this result, see the bootstrap docs for more details

outdirstr, optional

the output directory for the HTML

Returns:

indexstr

the path of the HTML written for this analysis

hveto.html.write_round(round_, context)

Write the HTML summary for a specific round

Parameters:

round_HvetoRound

the analysis round object

contextstr

context for bootstrap objects, default: info

Returns:

pagepage

the formatted HTML for this round

hveto.html.write_summary(rounds, plots=[], header='Summary', plotsperrow=4, tableclass='table table-sm table-hover')

Write the Hveto analysis summary HTML

Parameters:

roundslist of HvetoRound

the list of round objects produced by this analysis

plotslist of str, optional

the list of summary plots to display underneath the summary table

headerstr, optional

the text for the section header (<h2>)

plotsperrowint, optional

the number of plots to display in each row

tableclassstr, optional

the class for the summary <table>

Returns:

pagepage

the formatted markup object containing the analysis summary table, and images