-
Notifications
You must be signed in to change notification settings - Fork 229
Expand file tree
/
Copy pathindex.html
More file actions
168 lines (168 loc) · 8.65 KB
/
index.html
File metadata and controls
168 lines (168 loc) · 8.65 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
<!doctype html>
<html lang=en-us>
<head>
<meta charset="utf-8">
<title>Commercial Buildings Research - OpenStudio Documentation</title>
<link href="css/bootstrap.min.css" rel="stylesheet" type="text/css">
</head>
<body>
<div class="container">
<ul class="list-unstyled">
<li><a href="http://www.nrel.gov/buildings/">Buildings Research Home</a></li>
<li><a href="http://apps1.eere.energy.gov/buildings/energyplus/">DOE EnergyPlus Site</a></li>
<li><a href="http://apps1.eere.energy.gov/buildings/energyplus/openstudio_suite.cfm">DOE OpenStudio Site</a></li>
<li><a href="http://apps1.eere.energy.gov/buildings/energyplus/openstudio.cfm">DOE Legacy OpenStudio Site</a></li>
<li><a href="http://apps1.eere.energy.gov/buildings/energyplus/resultsviewer.cfm">DOE ResultsViewer Site</a></li>
</ul>
<h1>OpenStudio Platform Documentation</h1>
<h2>OpenStudio SDK Documentation</h2>
<p>The components of the OpenStudio SDK are documented for use by internal and external
interface developers. The C++ Documentation is the primary source for information
about the classes and methods available in the OpenStudio SDK. The Ruby
Documentation details name changes or other differences between the C++ interface
and the Ruby interface.</p>
<table class="table table-striped">
<tr>
<th>Component</th>
<th>Description</th>
<th>C++ Documentation</th>
<th>Ruby Documentation</th>
</tr>
<tr>
<td>Utilities</td>
<td>Utility functionality used throughout the OpenStudio C++ SDK. Includes parsers for Idf and Idd file formats.</td>
<td><a href="utilities/html/index.html">utilities</a><br/>
<a href="utilities_idd/html/index.html">utilities/idd</a></td>
<td><a href="../ruby/rdocify/OpenStudioUtilities/doc/index.html">OpenStudio Utilities</a><br/>
<a href="../ruby/rdocify/OpenStudioUtilitiesBCL/doc/index.html">OpenStudio BCL Utilities</a><br/>
<a href="../ruby/rdocify/OpenStudioUtilitiesCore/doc/index.html">OpenStudio Core Utilities</a><br/>
<a href="../ruby/rdocify/OpenStudioUtilitiesData/doc/index.html">OpenStudio Data Utilities</a><br/>
<a href="../ruby/rdocify/OpenStudioUtilitiesDocument/doc/index.html">OpenStudio Document Utilities</a><br/>
<a href="../ruby/rdocify/OpenStudioUtilitiesEconomics/doc/index.html">OpenStudio Economics Utilities</a><br/>
<a href="../ruby/rdocify/OpenStudioUtilitiesFileTypes/doc/index.html">OpenStudio FileTypes Utilities</a><br/>
<a href="../ruby/rdocify/OpenStudioUtilitiesGeometry/doc/index.html">OpenStudio Geometry Utilities</a><br/>
<a href="../ruby/rdocify/OpenStudioUtilitiesIdd/doc/index.html">OpenStudio Idd Utilities</a><br/>
<a href="../ruby/rdocify/OpenStudioUtilitiesIdf/doc/index.html">OpenStudio Idf Utilities</a><br/>
<a href="../ruby/rdocify/OpenStudioUtilitiesPlot/doc/index.html">OpenStudio Plot Utilities (deprecated)</a><br/>
<a href="../ruby/rdocify/OpenStudioUtilitiesSql/doc/index.html">OpenStudio Sql Utilities</a><br/>
<a href="../ruby/rdocify/OpenStudioUtilitiesTime/doc/index.html">OpenStudio Time Utilities</a><br/>
<a href="../ruby/rdocify/OpenStudioUtilitiesUnits/doc/index.html">OpenStudio Units Utilities</a></td>
</tr>
<tr>
<td>Building Modeler</td>
<td>The OpenStudio Building Model.</td>
<td><a href="model/html/index.html">model</a></td>
<td><a href="../ruby/rdocify/OpenStudioModel/doc/index.html">OpenStudio::Model</a><br/>
<a href="../ruby/rdocify/OpenStudioModelCore/doc/index.html">OpenStudio::Model (Core)</a><br/>
<a href="../ruby/rdocify/OpenStudioModelSimulation/doc/index.html">OpenStudio::Model (Simulation)</a><br/>
<a href="../ruby/rdocify/OpenStudioModelResources/doc/index.html">OpenStudio::Model (Resources)</a><br/>
<a href="../ruby/rdocify/OpenStudioModelGeometry/doc/index.html">OpenStudio::Model (Geometry)</a><br/>
<a href="../ruby/rdocify/OpenStudioModelHVAC/doc/index.html">OpenStudio::Model (HVAC)</a></td>
</tr>
<tr>
<td>Version Translator</td>
<td>Backwards compatibility for OpenStudio Model and Component.</td>
<td><a href="osversion/html/index.html">osversion</a></td>
<td><a href="../ruby/rdocify/OpenStudioOSVersion/doc/index.html">OpenStudio::OSVersion</a></td>
</tr>
<tr>
<td>EnergyPlus Manager</td>
<td>Translators to and from EnergyPlus.</td>
<td><a href="energyplus/html/index.html">energyplus</a></td>
<td><a href="../ruby/rdocify/OpenStudioEnergyPlus/doc/index.html">OpenStudio::EnergyPlus</a></td>
</tr>
<tr>
<td>Radiance Manager</td>
<td>Translators to and from Radiance.</td>
<td><a href="radiance/html/index.html">radiance</a></td>
<td><a href="../ruby/rdocify/OpenStudioRadiance/doc/index.html">OpenStudio::Radiance</a></td>
</tr>
<tr>
<td>Building Analyzer: Ruleset</td>
<td>Electronic representation of measures for changing or analyzing buildng energy models</td>
<td><a href="ruleset/html/index.html">ruleset</a></td>
<td><a href="../ruby/rdocify/OpenStudioRuleset/doc/index.html">OpenStudio::Ruleset</a></td>
</tr>
<tr>
<td>Run Manager</td>
<td>Simulation workflow and run management functionality.</td>
<td><a href="runmanager_lib/html/index.html">runmanager</a></td>
<td><a href="../ruby/rdocify/OpenStudioRunManager/doc/index.html">OpenStudio::Runmanager</a></td>
</tr>
<tr>
<td>Building Analyzer: Analysis Framework</td>
<td>Perturbation, optimization, and uncertainty handling of OpenStudio Building Models.</td>
<td><a href="analysis/html/index.html">analysis</a></td>
<td><a href="../ruby/rdocify/OpenStudioAnalysis/doc/index.html">OpenStudio::Analysis</a></td>
</tr>
<tr>
<td>Project Manager</td>
<td>Management of multiple OpenStudio Building Models associated with a single project.</td>
<td><a href="project/html/index.html">project</a></td>
<td><a href="../ruby/rdocify/OpenStudioProject/doc/index.html">OpenStudio::Project</a></td>
</tr>
<tr>
<td>Analysis Manager</td>
<td>Management of applying analysis::Algorithms to analysis::Problems, with data
persistence to a project database. </td>
<td><a href="analysisdriver/html/index.html">analysisdriver</a></td>
<td><a href="../ruby/rdocify/OpenStudioAnalysisDriver/doc/index.html">OpenStudio::AnalysisDriver</a></td>
</tr>
<tr>
<td>Translator: gbXML</td>
<td>Import of gbXML models into OpenStudio</td>
<td><a href="gbxml/html/index.html">gbxml</a></td>
<td><a href="../ruby/rdocify/OpenStudioGBXML/doc/index.html">OpenStudio::GbXML</a></td>
</tr>
<tr>
<td>Translator: SDD</td>
<td>Import and export of SDD models</td>
<td><a href="sdd/html/index.html">sdd</a></td>
<td><a href="../ruby/rdocify/OpenStudioSDD/doc/index.html">OpenStudio::SDD</a></td>
</tr>
<tr>
<td>OpenStudio Application Components</td>
<td>Library of Qt Widgets and related code that is used to build up the OpenStudio Application</td>
<td><a href="openstudio_lib/html/index.html">openstudio_lib</a><br/>
<a href="model_editor/html/index.html">model_editor</a></td>
<td><a href="../ruby/rdocify/OpenStudioLib/doc/index.html">OpenStudio::Openstudiolib</a><br/>
<a href="../ruby/rdocify/OpenStudioModelEditor/doc/index.html">OpenStudio::Modeleditor</a></td>
</tr>
</table>
<h2>OpenStudio Application Documentation for Developers</h2>
<table class="table table-striped">
<tr>
<th>Application</th>
<th>Description</th>
<th>Documentation</th>
</tr>
<tr>
<td>OpenStudio Plug-in for SketchUp</td>
<td>Programmers guide to the OpenStudio Plug-in for SketchUp</td>
<td><a href="../ruby/rdocify/OpenStudio/doc/index.html">OpenStudio::Plugin</a><br/>
<a href="plugin/html/index.html">plugin</a></td>
</tr>
<tr>
<td>OpenStudio Application</td>
<td>Building energy modeling and analysis interface for one model</td>
<td><a href="openstudio_app/html/index.html">openstudio_app</a></td>
</tr>
<tr>
<td>ParametricAnalysisTool</td>
<td>Create, run, and compare design alternatives</td>
<td><a href="pat_app/html/index.html">pat_app</a></td>
</tr>
<tr>
<td>ResultsViewer</td>
<td>Browse and plot EnergyPlus Sqlite time series data</td>
<td><a href="resultsviewer/html/index.html">resultsviewer</a></td>
</tr>
<tr>
<td>RunManager</td>
<td>Run and monitor multiple simulation workflows</td>
<td><a href="runmanager_app/html/index.html">runmanager_app</a></td>
</tr>
</table>
</div>
</body>
</html>