Skip to content

Commit

Permalink
Merge branch 'main' of https://github.com/germolinal/simple_docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@germolinal
germolinal committed Dec 7, 2024
2 parents 732275c + b3c2b89 commit b1b9f65
Show file tree
Hide file tree
Showing 14 changed files with 392 additions and 285 deletions.
299 changes: 201 additions & 98 deletions auto_src/docs/index.html
View file
Original file line number Diff line number Diff line change
@@ -1,102 +1,205 @@
<!-- An HTML website that sais Hello SIMPLE! -->
<html>
<head>
<title>SIMPLE validation report</title>
</head>

<body>
<h1>Welcome to the <code>SIMPLE</code> validation report</h1>
<p>
<code>SIMPLE</code> aims to be as reliable and transparent as
possible. This report is a crucial piece of that effort.
</p>
<p>
Most of this report is automatically produced as part of
<code>SIMPLE</code>'s quality control protocols. This means that a
new version of this document is produced every time a new version of
<code>SIMPLE</code> is deployed. Even more, several of these tests
are required for a new version to be deployed, meaning that; if any
change reduced accuracy, these tests should prevent that change to
ever be deployed.
</p>

<h2>Input Output reference</h2>
<p>Find it <a href="./ioreference/book/index.html">HERE</a>.</p>
<p>
This documentation can give you an idea of what is and how
<code>SIMPLE</code> works.
</p>

<h2>Validation reports</h2>
<h3>Algorithms in use</h3>
<ul>
<li>
<a href="./validation/cold_wellington_apartment.html"
>Full apartment simulation - Comparison between SIMPLE and
EnergyPlus</a
>
</li>
<li>
<a href="./validation/cold_wellington_box.html"
>Simple room (i.e., a box) - Comparison between SIMPLE and
EnergyPlus</a
>
</li>
<li>
<a href="./validation/convection_coefficients.html"
>Convection coefficient comparison - Comparison between
SIMPLE and EnergyPlus</a
>
</li>
<li>
<a href="./validation/incident_ir_radiation.html"
>Infrared Radiation incident on surfaces - Comparison
between SIMPLE and EnergyPlus</a
>
</li>
<li>
<a href="./validation/incident_solar_radiation.html"
>Incident solar radiation - Comparison between SIMPLE and
EnergyPlus</a
>
</li>
<li>
<a href="./validation/infiltration.html"
>Infiltrations validation - Comparison between SIMPLE and
EnergyPlus</a
>
</li>
<li>
<a href="./validation/walls.html"
>Heat transfer through walls - Comparison between SIMPLE and
both Theoretical Equations and EnergyPlus</a
>
</li>
<li>
<a href="./validation/weather.html"
>Simple check to see whether SIMPLE and EnergyPlus are
sampling weather files in the same way</a
>
</li>
<li>
<a href="./validation/daylight_coefficient.html"
>Daylight Coefficient validation - Comparison between SIMPLE
and Radiance</a
>
</li>
</ul>

<h3>Algorithms in development</h3>
<ul>
<!-- <li><a href="./validation/ray_tracer.html">Ray tracing algorithms - Comparison between SIMPLE and

<head>
<title>SIMPLE validation report</title>
<style>
code {
font-family: 'Courier New', Courier, monospace;
font-weight: bold;
}
* {
font-family: Arial, Helvetica, sans-serif;
}

a {
color: inherit;
text-decoration: none;
}

a.primary {
background-color: #0071e3;
color: white;
padding: 0.8em 1em;
border: none;
border-radius: 0.5em;

display: inline-block;
}

body {
padding: 1em;
max-width: 800px;
margin: 0 auto;
padding-top: 3em;
background-color: rgb(245, 245, 245);
}

ul {
display: flex;
flex-wrap: wrap;
}

ul>li {
list-style: none;
margin: 0.2em;
width: 200px;
background-color: white;
border-radius: 0.4em;
box-shadow: 0 1px 3px rgba(0, 0, 0, 0.12), 0 1px 2px rgba(0, 0, 0, 0.24);
transition: all 0.3s cubic-bezier(.25, .8, .25, 1);
}

ul>li a {
display: block;
padding: 0.6em;
}

ul>li a h1 {
font-size: 1rem;
}

ul>li a p {
font-size: 0.9rem;
opacity: 0.6;
}

.danger {
color: red;
}

ul>li a p.danger {
font-size: 0.8rem;
}

li:hover {
box-shadow: 0 14px 28px rgba(0, 0, 0, 0.25), 0 10px 10px rgba(0, 0, 0, 0.22);
}
</style>
</head>

<body>
<h1>Welcome to <code>SIMPLE</code>'s documentation</h1>
<p>
<code>SIMPLE</code> aims to be as reliable and transparent as
possible. This report is a crucial piece of that effort.
</p>
<p>
Most of this report is automatically produced as part of
<code>SIMPLE</code>'s quality control protocols. This means that a
new version of this document is produced every time a new version of
<code>SIMPLE</code> is deployed. Even more, several of these tests
are required for a new version to be deployed, meaning that; if any
change reduced accuracy, these tests should prevent that change to
ever be deployed.
</p>


<a class="primary" href="./ioreference/book/index.html">Go to <code>SIMPLE</code>'s user guide</a>


<h2>Validation reports</h2>
<p>
We are quite transparent in our efforts to make SIMPLE reliable. We are not
perfect, but these are some of the tests we run every time we attempt to publish
a new verion. Also, this report is updated EVERY TIME we publish a new version.
Feel free to comment and—if you think you can make the results better—let us know
and we can work together.
</p>
<h3>Algorithms in use</h3>
<ul>
<li>
<a href="./validation/cold_wellington_apartment.html">
<h1>Full apartment simulation</h1>
<p>Comparison between and EnergyPlus</p>
</a>
</li>
<li>
<a href="./validation/cold_wellington_box.html">
<h1>Simple room (i.e., a box)</h1>
<p>Comparison between SIMPLE and EnergyPlus</p>
</a>
</li>
<li>
<a href="./validation/convection_coefficients.html">
<h1>Convection coefficient comparison</h1>
<p>
Comparison between SIMPLE and EnergyPlus
</p>
</a>
</li>
<li>
<a href="./validation/incident_ir_radiation.html">
<h1>
Infrared Radiation incident on surfaces
</h1>
<p>
Comparison between SIMPLE and EnergyPlus
</p>
</a>
</li>
<li>
<a href="./validation/incident_solar_radiation.html">
<h1>
Incident solar radiation
</h1>
<p>
Comparison between SIMPLE and EnergyPlus
</p>
</a>
</li>
<li>
<a href="./validation/infiltration.html">
<h1>Infiltrations validation</h1>
<p>Comparison between SIMPLE and EnergyPlus</p>
</a>
</li>
<li>
<a href="./validation/walls.html">
<h1>Heat transfer through walls</h1>
<p>Comparison between SIMPLE and
both Theoretical Equations and EnergyPlus</p>
</a>
</li>
<li>
<a href="./validation/weather.html">
<h1>Retrieved weather from EPW file</h1>
<p>
Check if SIMPLE and EnergyPlus are
sampling weather files in the same way
</p>
</a>
</li>
<li>
<a href="./validation/daylight_coefficient.html">
<h1>Daylight Coefficients</h1>
<p>Comparison between SIMPLE
and Radiance</p>
</a>
</li>
<li>
<a href="./validation/ray_tracer.html">
<h1>Ray tracing</h1>
<p>
Check if ray-tracing works well.
</p>
<p class="danger">The ray-tracer works, but we need to improve how some materials are modelled.</p>
</a>
</li>
</ul>

<h3>Algorithms in development</h3>
<ul>
<!-- <li><a href="./validation/ray_tracer.html">Ray tracing algorithms - Comparison between SIMPLE and
Radiance</a>
</li> -->
<li>
<a href="./validation/global_horizontal_from_cloud_cover.html"
>Algorithms used to estimate solar radiation based on cloud
cover data</a
>
</li>
</ul>
</body>
</html>
<li>
<a href="./validation/global_horizontal_from_cloud_cover.html">
<h1>Derive solar radiation from cloud cover</h1>
<p class="danger">This does not work too well, but is not currently in use</p>
</a>
</li>
</ul>
</body>

</html>
9 changes: 6 additions & 3 deletions auto_src/docs/ioreference/src/auto-building.md
View file
Original file line number Diff line number Diff line change
@@ -1,8 +1,11 @@
# Building

This object is utilized to group `Space` objects together for
metering and/or shared values. For example, the number of storeys
and the `ShelterClass` will help defining the `Infiltrations`
This object has two purposes. First, it can be utilized to group
`Space` objects together for metering. Also, there are some
physical aspects of the the building that can be calculated from
some parameters of the building. For example, the `Infiltrations`
can be estimated from the number of storeys
and the `ShelterClass` (check docs for those).

## Examples

Expand Down
4 changes: 2 additions & 2 deletions auto_src/docs/ioreference/src/auto-hvac.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,14 @@ A collection of elements heating and cooling systems

## Example `.spl`

```rs
```json
{{ #include ../../../model/tests/scanner/hvac_electric_heater.spl }}

```

## Example `.json`

```rs
```json
{{ #include ../../../model/tests//scanner/hvac_electric_heater.json }}

```
Expand Down
Loading

0 comments on commit b1b9f65

Please sign in to comment.