Capturing javadoc.

Will need to be periodically manually updated as code is.
DamonHD · Nov 15, 2023 · ec95ed0 · ec95ed0
1 parent d55c7bc
commit ec95ed0
Show file tree

Hide file tree

Showing 61 changed files with 15,565 additions and 0 deletions.
diff --git a/javadoc/allclasses-index.html b/javadoc/allclasses-index.html
@@ -0,0 +1,128 @@
+<!DOCTYPE HTML>
+<html lang="en">
+<head>
+<!-- Generated by javadoc (19) on Wed Nov 15 14:42:07 GMT 2023 -->
+<title>All Classes and Interfaces (TRVmodel V0.9.4 Javadoc)</title>
+<meta name="viewport" content="width=device-width, initial-scale=1">
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<meta name="dc.created" content="2023-11-15">
+<meta name="description" content="class index">
+<meta name="generator" content="javadoc/AllClassesIndexWriter">
+<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
+<link rel="stylesheet" type="text/css" href="script-dir/jquery-ui.min.css" title="Style">
+<link rel="stylesheet" type="text/css" href="jquery-ui.overrides.css" title="Style">
+<script type="text/javascript" src="script.js"></script>
+<script type="text/javascript" src="script-dir/jquery-3.6.0.min.js"></script>
+<script type="text/javascript" src="script-dir/jquery-ui.min.js"></script>
+</head>
+<body class="all-classes-index-page">
+<script type="text/javascript">var pathtoroot = "./";
+loadScripts(document, 'script');</script>
+<noscript>
+<div>JavaScript is disabled on your browser.</div>
+</noscript>
+<div class="flex-box">
+<header role="banner" class="flex-header">
+<nav role="navigation">
+<!-- ========= START OF TOP NAVBAR ======= -->
+<div class="top-nav" id="navbar-top"><button id="navbar-toggle-button" aria-controls="navbar-top" aria-expanded="false" aria-label="Toggle navigation links"><span class="nav-bar-toggle-icon">&nbsp;</span><span class="nav-bar-toggle-icon">&nbsp;</span><span class="nav-bar-toggle-icon">&nbsp;</span></button>
+<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
+<div class="about-language">
+<a href="http://d.hd.org/" target="_top">TRVmodel</a> V0.9.4<br />
+ </div>
+<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
+<li><a href="index.html">Overview</a></li>
+<li>Package</li>
+<li>Class</li>
+<li><a href="overview-tree.html">Tree</a></li>
+<li><a href="index-all.html">Index</a></li>
+<li><a href="help-doc.html#all-classes">Help</a></li>
+</ul>
+</div>
+<div class="sub-nav">
+<div id="navbar-sub-list"></div>
+<div class="nav-list-search"><a href="search.html">SEARCH</a>
+<input type="text" id="search-input" disabled placeholder="Search">
+<input type="reset" id="reset-button" disabled value="reset">
+</div>
+</div>
+<!-- ========= END OF TOP NAVBAR ========= -->
+<span class="skip-nav" id="skip-navbar-top"></span></nav>
+</header>
+<div class="flex-content">
+<main role="main">
+<div class="header">
+<h1 title="All Classes and Interfaces" class="title">All Classes and Interfaces</h1>
+</div>
+<div id="all-classes-table">
+<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="all-classes-table-tab0" role="tab" aria-selected="true" aria-controls="all-classes-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('all-classes-table', 'all-classes-table', 2)" class="active-table-tab">All Classes and Interfaces</button><button id="all-classes-table-tab2" role="tab" aria-selected="false" aria-controls="all-classes-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('all-classes-table', 'all-classes-table-tab2', 2)" class="table-tab">Classes</button><button id="all-classes-table-tab4" role="tab" aria-selected="false" aria-controls="all-classes-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('all-classes-table', 'all-classes-table-tab4', 2)" class="table-tab">Record Classes</button></div>
+<div id="all-classes-table.tabpanel" role="tabpanel">
+<div class="summary-table two-column-summary" aria-labelledby="all-classes-table-tab0">
+<div class="table-header col-first">Class</div>
+<div class="table-header col-last">Description</div>
+<div class="col-first even-row-color all-classes-table all-classes-table-tab4"><a href="org/hd/d/TRVmodel/data/DDNTemperatureDataCSV.html" title="class in org.hd.d.TRVmodel.data">DDNTemperatureDataCSV</a></div>
+<div class="col-last even-row-color all-classes-table all-classes-table-tab4">
+<div class="block">Wraps degreedays.net hourly temperature CSV data to make it clear what it is; data cannot be null.</div>
+</div>
+<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="org/hd/d/TRVmodel/hg/HGTRVHPMModel.html" title="class in org.hd.d.TRVmodel.hg">HGTRVHPMModel</a></div>
+<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
+<div class="block">Recreation of the heat-pump / TRV / energy interactions from Heat Geek's page:
+ <a href="https://www.heatgeek.com/why-not-to-zone-heat-pumps-or-boilers/">https://www.heatgeek.com/why-not-to-zone-heat-pumps-or-boilers/</a>
+ as of ~2023-06.</div>
+</div>
+<div class="col-first even-row-color all-classes-table all-classes-table-tab4"><a href="org/hd/d/TRVmodel/hg/HGTRVHPMModelByHour.html" title="class in org.hd.d.TRVmodel.hg">HGTRVHPMModelByHour</a></div>
+<div class="col-last even-row-color all-classes-table all-classes-table-tab4">
+<div class="block">Drives the parameterised HG model variant(s) with hourly external temperature data.</div>
+</div>
+<div class="col-first odd-row-color all-classes-table all-classes-table-tab4"><a href="org/hd/d/TRVmodel/hg/HGTRVHPMModelByHour.ScenarioResult.html" title="class in org.hd.d.TRVmodel.hg">HGTRVHPMModelByHour.ScenarioResult</a></div>
+<div class="col-last odd-row-color all-classes-table all-classes-table-tab4">
+<div class="block">Results of running a model against a temperature set.</div>
+</div>
+<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="org/hd/d/TRVmodel/hg/HGTRVHPMModelExtensions.html" title="class in org.hd.d.TRVmodel.hg">HGTRVHPMModelExtensions</a></div>
+<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
+<div class="block">Simple static extensions to the recreation of the heat-pump / TRV / energy interactions from Heat Geek's page:
+ <a href="https://www.heatgeek.com/why-not-to-zone-heat-pumps-or-boilers/">https://www.heatgeek.com/why-not-to-zone-heat-pumps-or-boilers/</a>
+ as of ~2023-06.</div>
+</div>
+<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="org/hd/d/TRVmodel/hg/HGTRVHPMModelParameterised.html" title="class in org.hd.d.TRVmodel.hg">HGTRVHPMModelParameterised</a></div>
+<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
+<div class="block">Parameterised recreation of the heat-pump / TRV / energy interactions from Heat Geek's page:
+ <a href="https://www.heatgeek.com/why-not-to-zone-heat-pumps-or-boilers/">https://www.heatgeek.com/why-not-to-zone-heat-pumps-or-boilers/</a>
+ as of ~2023-06.</div>
+</div>
+<div class="col-first even-row-color all-classes-table all-classes-table-tab4"><a href="org/hd/d/TRVmodel/hg/HGTRVHPMModelParameterised.DemandWithoutAndWithSetback.html" title="class in org.hd.d.TRVmodel.hg">HGTRVHPMModelParameterised.DemandWithoutAndWithSetback</a></div>
+<div class="col-last even-row-color all-classes-table all-classes-table-tab4">
+<div class="block">Home heat and electricity demand with and without setback in B rooms; both non-null.</div>
+</div>
+<div class="col-first odd-row-color all-classes-table all-classes-table-tab4"><a href="org/hd/d/TRVmodel/hg/HGTRVHPMModelParameterised.HeatAndElectricityDemand.html" title="class in org.hd.d.TRVmodel.hg">HGTRVHPMModelParameterised.HeatAndElectricityDemand</a></div>
+<div class="col-last odd-row-color all-classes-table all-classes-table-tab4">
+<div class="block">Heat demand and the electricity input to the heat pump to meet it (W).</div>
+</div>
+<div class="col-first even-row-color all-classes-table all-classes-table-tab4"><a href="org/hd/d/TRVmodel/hg/HGTRVHPMModelParameterised.ModelParameters.html" title="class in org.hd.d.TRVmodel.hg">HGTRVHPMModelParameterised.ModelParameters</a></div>
+<div class="col-last even-row-color all-classes-table all-classes-table-tab4">
+<div class="block">Parameters for this version of the model.</div>
+</div>
+<div class="col-first odd-row-color all-classes-table all-classes-table-tab4"><a href="org/hd/d/TRVmodel/data/HourlyTemperatureDataDescriptor.html" title="class in org.hd.d.TRVmodel.data">HourlyTemperatureDataDescriptor</a></div>
+<div class="col-last odd-row-color all-classes-table all-classes-table-tab4">
+<div class="block">A descriptor for an hourly temperature data file.</div>
+</div>
+<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="org/hd/d/TRVmodel/Main.html" title="class in org.hd.d.TRVmodel">Main</a></div>
+<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
+<div class="block">Main (command-line) entry-point for the data handler.</div>
+</div>
+<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="org/hd/d/TRVmodel/hg/ShowComputations.html" title="class in org.hd.d.TRVmodel.hg">ShowComputations</a></div>
+<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
+<div class="block">Show computations from the Heat Geek TRV/HP model.</div>
+</div>
+</div>
+</div>
+</div>
+</main>
+<footer role="contentinfo">
+<hr>
+<p class="legal-copy"><small>Copyright (c) 2023, Damon Hart-Davis.</small></p>
+</footer>
+</div>
+</div>
+</body>
+</html>
diff --git a/javadoc/allpackages-index.html b/javadoc/allpackages-index.html
@@ -0,0 +1,84 @@
+<!DOCTYPE HTML>
+<html lang="en">
+<head>
+<!-- Generated by javadoc (19) on Wed Nov 15 14:42:07 GMT 2023 -->
+<title>All Packages (TRVmodel V0.9.4 Javadoc)</title>
+<meta name="viewport" content="width=device-width, initial-scale=1">
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<meta name="dc.created" content="2023-11-15">
+<meta name="description" content="package index">
+<meta name="generator" content="javadoc/AllPackagesIndexWriter">
+<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
+<link rel="stylesheet" type="text/css" href="script-dir/jquery-ui.min.css" title="Style">
+<link rel="stylesheet" type="text/css" href="jquery-ui.overrides.css" title="Style">
+<script type="text/javascript" src="script.js"></script>
+<script type="text/javascript" src="script-dir/jquery-3.6.0.min.js"></script>
+<script type="text/javascript" src="script-dir/jquery-ui.min.js"></script>
+</head>
+<body class="all-packages-index-page">
+<script type="text/javascript">var pathtoroot = "./";
+loadScripts(document, 'script');</script>
+<noscript>
+<div>JavaScript is disabled on your browser.</div>
+</noscript>
+<div class="flex-box">
+<header role="banner" class="flex-header">
+<nav role="navigation">
+<!-- ========= START OF TOP NAVBAR ======= -->
+<div class="top-nav" id="navbar-top"><button id="navbar-toggle-button" aria-controls="navbar-top" aria-expanded="false" aria-label="Toggle navigation links"><span class="nav-bar-toggle-icon">&nbsp;</span><span class="nav-bar-toggle-icon">&nbsp;</span><span class="nav-bar-toggle-icon">&nbsp;</span></button>
+<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
+<div class="about-language">
+<a href="http://d.hd.org/" target="_top">TRVmodel</a> V0.9.4<br />
+ </div>
+<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
+<li><a href="index.html">Overview</a></li>
+<li>Package</li>
+<li>Class</li>
+<li><a href="overview-tree.html">Tree</a></li>
+<li><a href="index-all.html">Index</a></li>
+<li><a href="help-doc.html#all-packages">Help</a></li>
+</ul>
+</div>
+<div class="sub-nav">
+<div id="navbar-sub-list"></div>
+<div class="nav-list-search"><a href="search.html">SEARCH</a>
+<input type="text" id="search-input" disabled placeholder="Search">
+<input type="reset" id="reset-button" disabled value="reset">
+</div>
+</div>
+<!-- ========= END OF TOP NAVBAR ========= -->
+<span class="skip-nav" id="skip-navbar-top"></span></nav>
+</header>
+<div class="flex-content">
+<main role="main">
+<div class="header">
+<h1 title="All&amp;nbsp;Packages" class="title">All&nbsp;Packages</h1>
+</div>
+<div class="caption"><span>Package Summary</span></div>
+<div class="summary-table two-column-summary">
+<div class="table-header col-first">Package</div>
+<div class="table-header col-last">Description</div>
+<div class="col-first even-row-color"><a href="org/hd/d/TRVmodel/package-summary.html">org.hd.d.TRVmodel</a></div>
+<div class="col-last even-row-color">
+<div class="block">Top-level package for TRVModel, contains main().</div>
+</div>
+<div class="col-first odd-row-color"><a href="org/hd/d/TRVmodel/data/package-summary.html">org.hd.d.TRVmodel.data</a></div>
+<div class="col-last odd-row-color">
+<div class="block">Loading and decoding data.</div>
+</div>
+<div class="col-first even-row-color"><a href="org/hd/d/TRVmodel/hg/package-summary.html">org.hd.d.TRVmodel.hg</a></div>
+<div class="col-last even-row-color">
+<div class="block">Recreating and generalising the heat-pump / TRV / energy interactions from Heat Geek's page:
+ <a href="https://www.heatgeek.com/why-not-to-zone-heat-pumps-or-boilers/">https://www.heatgeek.com/why-not-to-zone-heat-pumps-or-boilers/</a>
+ as of ~2023-06.</div>
+</div>
+</div>
+</main>
+<footer role="contentinfo">
+<hr>
+<p class="legal-copy"><small>Copyright (c) 2023, Damon Hart-Davis.</small></p>
+</footer>
+</div>
+</div>
+</body>
+</html>