HTML construction¶
Almost all the command-line tools bundled with GWDetChar are designed to produce nicely-formatted HTML output with custom CSS style formatting based on Twitter Bootstrap. The output pages are constructed programatically using MarkupPy
and a collection of custom python tools.
The gwdetchar.io.html
module provides the following classes and functions:
|
A helpful class of objects that coalesce image links and caption text for fancybox figures. |
|
Create a new |
|
Construct a navigation bar in bootstrap format |
|
Return a brand for navigation bar formatting |
|
Write a blurb documenting how a page was generated, including the command-line arguments and configuration files used |
|
Render the command-line invocation used to generate a page |
|
Return the markup to embed an <img> in HTML |
|
Embed a |
|
Write a <table> with one row of headers and many rows of data |
|
Write HTML for data-quality flags |
|
Write a <footer> for a bootstrap page |
|
Close an HTML document with markup then write to disk |
All output pages feature basic contextual information for that analysis, including the full command-line needed to reproduce it. For analyses that require configuration files (e.g., omega scans), a separate ‘about’ page is written that displays each configuration file used as well as a table of package versions installed in the environment at runtime.
The gwdetchar.omega.html
module also provides functions specific to omega scan output pages:
|
Decorator to wrap a function with |
|
Create a Bootstrap button object that toggles between plot types. |
|
Write a summary table in various formats for users to download |
|
Write the Qscan analysis summary HTML |
|
Write a table of channels ranked by their similarity to the primary |
|
Write the HTML summary for a specific block of channels |
|
Write the Qscan results to HTML |
For more information, please refer to these individual modules.