Skip to content

Commit 7a886b2

Browse files
kastnerpkastnerp
authored
Merge pull request #77 from Eddy3D-Dev/dev
Release 1.7.0.827: publish the regenerated component docs
2 parents 6e7f741 + a4787f9 commit 7a886b2

509 files changed

Lines changed: 2064 additions & 808 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎docs/Components.md‎

Lines changed: 557 additions & 299 deletions
Large diffs are not rendered by default.

docs/categories/00_Utilities.md renamed to docs/categories/01_Utilities.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
{!toolbar.md!}
22

33
<style>
4-
.Main-GhToolbar-Container .SubGroup-Container:not([data-category="00_Utilities"]) {
4+
.Main-GhToolbar-Container .SubGroup-Container:not([data-category="01_Utilities"]) {
55
filter: grayscale(1);
66
opacity: 0.35;
77
}
88
</style>
99

10-
# 00 Utilities
10+
# 01 Utilities
1111
<h4 id="main-components">Main Components</h4>
1212
<div class="index-quicklink-container">
1313
<a href="/components/STL_Exporter/" style="text-decoration: none;">
@@ -26,5 +26,13 @@
2626
<div class="index-quicklink-text">A boolean toggle that is always FALSE when a file is opened. Useful for preventing automatic execution of heavy ML models. Double-click to toggle.</div>
2727
</div>
2828
</a>
29+
<a href="/components/Settle_Data/" style="text-decoration: none;">
30+
<div class="index-quicklink">
31+
<div class="index-quicklink-title">
32+
<img src="/images/icons/Settle_Data.png" class="nav-gh-icon"> Settle Data
33+
</div>
34+
<div class="index-quicklink-text">Hold the last output while the left mouse button is pressed, then publish the newest value when the button is released. Useful between an MD Slider and an expensive component.</div>
35+
</div>
36+
</a>
2937
</div>
3038

docs/categories/01_Outdoor_Setup.md renamed to docs/categories/02_Outdoor_Setup.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
{!toolbar.md!}
22

33
<style>
4-
.Main-GhToolbar-Container .SubGroup-Container:not([data-category="01_Outdoor_Setup"]) {
4+
.Main-GhToolbar-Container .SubGroup-Container:not([data-category="02_Outdoor_Setup"]) {
55
filter: grayscale(1);
66
opacity: 0.35;
77
}
88
</style>
99

10-
# 01 Outdoor Setup
10+
# 02 Outdoor Setup
1111
<h4 id="main-components">Main Components</h4>
1212
<div class="index-quicklink-container">
1313
<a href="/components/Atmospheric_Boundary_Layer/" style="text-decoration: none;">
@@ -39,15 +39,7 @@
3939
<div class="index-quicklink-title">
4040
<img src="/images/icons/Download_Weather.png" class="nav-gh-icon"> Download Weather
4141
</div>
42-
<div class="index-quicklink-text">Download an EPW weather file from climate.onebuilding.org nearest to your project location. Use the Search input to filter by station name, WMO ID, or dataset year.</div>
43-
</div>
44-
</a>
45-
<a href="/components/Translate_Date_To_Hours/" style="text-decoration: none;">
46-
<div class="index-quicklink">
47-
<div class="index-quicklink-title">
48-
<img src="/images/icons/Translate_Date_To_Hours.png" class="nav-gh-icon"> Translate Date To Hours
49-
</div>
50-
<div class="index-quicklink-text">Translate a Ladybug analysis period to hours of the year.</div>
42+
<div class="index-quicklink-text">Download an EPW weather file from a direct URL, or search climate.onebuilding.org by station name, WMO ID, or dataset year.</div>
5143
</div>
5244
</a>
5345
<a href="/components/Wind_Compass/" style="text-decoration: none;">
@@ -66,12 +58,20 @@
6658
<div class="index-quicklink-text">Cluster annual wind directions into representative directions using k-means.</div>
6759
</div>
6860
</a>
69-
<a href="/components/Gmsh_Mesh/" style="text-decoration: none;">
61+
<a href="/components/Ground_Roughness/" style="text-decoration: none;">
62+
<div class="index-quicklink">
63+
<div class="index-quicklink-title">
64+
<img src="/images/icons/Ground_Roughness.png" class="nav-gh-icon"> Ground Roughness
65+
</div>
66+
<div class="index-quicklink-text">Assign a multi-face ground plate to the wind tunnel: each face gets its own aerodynamic roughness length z0 and becomes its own ground patch (nutkAtmRoughWallFunction). Feed into the wind case component's Ground Roughness input.</div>
67+
</div>
68+
</a>
69+
<a href="/components/Land_Cover_Roughness/" style="text-decoration: none;">
7070
<div class="index-quicklink">
7171
<div class="index-quicklink-title">
72-
<img src="/images/icons/Gmsh_Mesh.png" class="nav-gh-icon"> Gmsh Mesh
72+
<img src="/images/icons/Land_Cover_Roughness.png" class="nav-gh-icon"> Land Cover Roughness
7373
</div>
74-
<div class="index-quicklink-text">Creates a STL mesh from geometry using the gmsh application. Useful to create healthy mesh topologies for building elements.</div>
74+
<div class="index-quicklink-text">Fetch land-cover polygons around a location from OpenStreetMap (open data, Overpass API) and classify each into an aerodynamic roughness length via the Davenport-Wieringa terrain classification. Outputs ready-made ground roughness zones for the wind case.</div>
7575
</div>
7676
</a>
7777
<a href="/components/Tree/" style="text-decoration: none;">

docs/categories/02_Outdoor_Domain_Mesh.md renamed to docs/categories/03_Outdoor_Domain_Mesh.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,21 @@
11
{!toolbar.md!}
22

33
<style>
4-
.Main-GhToolbar-Container .SubGroup-Container:not([data-category="02_Outdoor_Domain_Mesh"]) {
4+
.Main-GhToolbar-Container .SubGroup-Container:not([data-category="03_Outdoor_Domain_Mesh"]) {
55
filter: grayscale(1);
66
opacity: 0.35;
77
}
88
</style>
99

10-
# 02 Outdoor Domain Mesh
10+
# 03 Outdoor Domain Mesh
1111
<h4 id="main-components">Main Components</h4>
1212
<div class="index-quicklink-container">
1313
<a href="/components/Cylinder_Domain/" style="text-decoration: none;">
1414
<div class="index-quicklink">
1515
<div class="index-quicklink-title">
1616
<img src="/images/icons/Cylinder_Domain.png" class="nav-gh-icon"> Cylinder Domain
1717
</div>
18-
<div class="index-quicklink-text">Define a cylindrical simulation domain for Eddy3D. One cylindrical mesh serves all wind directions; the cylinder side faces switch between inlet and outlet per direction.</div>
18+
<div class="index-quicklink-text">Define a cylindrical simulation domain for Eddy3D. One cylindrical mesh serves all wind directions; the cylinder side faces switch between inlet and outlet per direction. The auto radius targets the 3% frontal-blockage limit of ASCE/SEI CWE Prestandard AC 6-8b, which the case component verifies. Model surrounding buildings within ~240 m of the study area (ASCE 49 proximity guidance) before trusting results near the context edge.</div>
1919
</div>
2020
</a>
2121
<a href="/components/Cell_Size/" style="text-decoration: none;">
@@ -39,15 +39,15 @@
3939
<div class="index-quicklink-title">
4040
<img src="/images/icons/Refinement_Region.png" class="nav-gh-icon"> Refinement Region
4141
</div>
42-
<div class="index-quicklink-text">Add a custom snappyHexMesh refinement region (a box, solid or surface) to a written case's mesh, then re-mesh. Refines the cells inside/near the geometry to the chosen level.</div>
42+
<div class="index-quicklink-text">Add a custom snappyHexMesh refinement region (a box, solid or surface) to a written case's mesh. Refines the cells inside/near the geometry to the chosen level; re-run meshing separately afterward to apply it.</div>
4343
</div>
4444
</a>
4545
<a href="/components/Brep_Grid_Points/" style="text-decoration: none;">
4646
<div class="index-quicklink">
4747
<div class="index-quicklink-title">
4848
<img src="/images/icons/Brep_Grid_Points.png" class="nav-gh-icon"> Brep Grid Points
4949
</div>
50-
<div class="index-quicklink-text">Generate a regular point grid on Brep, surface, or mesh geometry.</div>
50+
<div class="index-quicklink-text">Generate centered surface samples on the actual faces of Brep, surface, or mesh geometry.</div>
5151
</div>
5252
</a>
5353
</div>

docs/categories/03_Outdoor_Case.md renamed to docs/categories/04_Outdoor_Case.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
{!toolbar.md!}
22

33
<style>
4-
.Main-GhToolbar-Container .SubGroup-Container:not([data-category="03_Outdoor_Case"]) {
4+
.Main-GhToolbar-Container .SubGroup-Container:not([data-category="04_Outdoor_Case"]) {
55
filter: grayscale(1);
66
opacity: 0.35;
77
}
88
</style>
99

10-
# 03 Outdoor Case
10+
# 04 Outdoor Case
1111
<h4 id="main-components">Main Components</h4>
1212
<div class="index-quicklink-container">
1313
<a href="/components/Load_Wind_Case/" style="text-decoration: none;">

docs/categories/04_Outdoor_Simulation.md renamed to docs/categories/05_Outdoor_Simulation.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
{!toolbar.md!}
22

33
<style>
4-
.Main-GhToolbar-Container .SubGroup-Container:not([data-category="04_Outdoor_Simulation"]) {
4+
.Main-GhToolbar-Container .SubGroup-Container:not([data-category="05_Outdoor_Simulation"]) {
55
filter: grayscale(1);
66
opacity: 0.35;
77
}
88
</style>
99

10-
# 04 Outdoor Simulation
10+
# 05 Outdoor Simulation
1111
<h4 id="main-components">Main Components</h4>
1212
<div class="index-quicklink-container">
1313
<a href="/components/Run/" style="text-decoration: none;">

docs/categories/05_Outdoor_Results.md renamed to docs/categories/06_Outdoor_Results.md

Lines changed: 18 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,15 @@
11
{!toolbar.md!}
22

33
<style>
4-
.Main-GhToolbar-Container .SubGroup-Container:not([data-category="05_Outdoor_Results"]) {
4+
.Main-GhToolbar-Container .SubGroup-Container:not([data-category="06_Outdoor_Results"]) {
55
filter: grayscale(1);
66
opacity: 0.35;
77
}
88
</style>
99

10-
# 05 Outdoor Results
10+
# 06 Outdoor Results
1111
<h4 id="main-components">Main Components</h4>
1212
<div class="index-quicklink-container">
13-
<a href="/components/Probe/" style="text-decoration: none;">
14-
<div class="index-quicklink">
15-
<div class="index-quicklink-title">
16-
<img src="/images/icons/Probe.png" class="nav-gh-icon"> Probe
17-
</div>
18-
<div class="index-quicklink-text">Sample fields at points on a solved case, post-hoc. With Run it writes a probes function and runs postProcess on the requested Time (latest by default), then reads the results; without Run it reads existing results. Works on a wind case (one sub-result per direction) or a loaded case.</div>
19-
</div>
20-
</a>
2113
<a href="/components/Live_Residuals/" style="text-decoration: none;">
2214
<div class="index-quicklink">
2315
<div class="index-quicklink-title">
@@ -42,6 +34,14 @@
4234
<div class="index-quicklink-text">Open the web-based residual plotter for a wind case's convergence history (one trace per direction).</div>
4335
</div>
4436
</a>
37+
<a href="/components/Translate_Date_To_Hours/" style="text-decoration: none;">
38+
<div class="index-quicklink">
39+
<div class="index-quicklink-title">
40+
<img src="/images/icons/Translate_Date_To_Hours.png" class="nav-gh-icon"> Translate Date To Hours
41+
</div>
42+
<div class="index-quicklink-text">Translate a Ladybug analysis period to hours of the year.</div>
43+
</div>
44+
</a>
4545
<a href="/components/Calendar/" style="text-decoration: none;">
4646
<div class="index-quicklink">
4747
<div class="index-quicklink-title">
@@ -82,6 +82,14 @@
8282
<div class="index-quicklink-text">Visualize a probed wind field: colored velocity arrows, a point cloud, a heatmap mesh, streamlines, or volumetric smoke (pick via Display Mode). Feed the Probe component's points + velocity vectors (Field = U), or any points + vectors.</div>
8383
</div>
8484
</a>
85+
<a href="/components/Wind_Legend/" style="text-decoration: none;">
86+
<div class="index-quicklink">
87+
<div class="index-quicklink-title">
88+
<img src="/images/icons/Wind_Legend.png" class="nav-gh-icon"> Wind Legend
89+
</div>
90+
<div class="index-quicklink-text">Color-scale legend for wind speed: a colored bar with labeled ticks matching the Wind Field Viewer's ramp. Wire the viewer's Range output into Range so the legend always shows the span the colors actually map, and pick the same Color Map.</div>
91+
</div>
92+
</a>
8593
<a href="/components/Analysis_Period/" style="text-decoration: none;">
8694
<div class="index-quicklink">
8795
<div class="index-quicklink-title">

‎docs/categories/07_MRT.md‎

Lines changed: 0 additions & 126 deletions
This file was deleted.

0 commit comments

Comments
 (0)