Commit d93e35c7 authored by Olivier Tournaire's avatar Olivier Tournaire
Browse files

Merge tag 'v0.6.0'

parents 7c2b864e 484a28c0
This diff is collapsed.
This diff is collapsed.
......@@ -3,9 +3,9 @@
## Abstract
The Application Domain Extension (ADE) Energy defines a standardized data model based on CityGML format for urban energy analyses, aiming to be a reference exchange data format between different urban modelling tools and expert databases.
A documentation of each classes and parameters is in development on [iCloud](https://www.icloud.com/numbers/AwBWCAESEGokFkzrlOmbyLGSLf4aK1MaKml1UIi8WFdwYdhK0UTcW3yK1E1VdLPbAvkAdtkW6y9YHtsf7z8AYI2nqQMCUCAQEEICNf39VHMKgzmmsZDBWw4hJ1n2O0bfur2wdp6Xm6i0ZA#Definitionen).
A documentation of each classes and parameters is in development as an [Excel sheet](./doc/Definitions_Energy-ADE.xlsx?raw=true).
The latest ADE release is version 0.5.0. All releases can be found and downloaded on the [releases page](https://github.com/cstb/citygml-energy/releases) of the repository.
The latest ADE release is version 0.6.0. All releases can be found and downloaded on the [releases page](https://github.com/cstb/citygml-energy/releases) of the repository.
It has been developed since May 2014 by an international consortium of urban energy simulation developers and users:
* Special Interest Group 3D (SIG3D)
......@@ -22,67 +22,17 @@ It has been developed since May 2014 by an international consortium of urban ene
* M.O.S.S Computer Grafik Systeme
* Austrian Institute of Technology
![Special Interest Group 3D](./doc/201309_SIG3D_Logo.png) ![University of Applied Sciences Stuttgart logo](./doc/hft.jpg) ![Technische Universität München logo](./doc/tum.png) ![Karlsruhe Institute für Technologie logo](./doc/kit.jpg)
![RWTH Aachen University / E.ON Energy Research Center logo](./doc/rwth_eon.jpg) ![HafenCityUniversität Hamburg logo](./doc/hcu.png) ![European Institute for Energy Research logo](./doc/eifer.png)
![Ecole Polytechnique Fédérale de Lausanne logo](./doc/epfl.png) ![Centre Scientifique et Technique du Batiment logo](./doc/cstb.png) ![Electricité de France logo](./doc/edf.jpg)
![Sinergis logo](./doc/sinergis.png) ![M.O.S.S Computer Grafik Systeme logo](./doc/moss.jpg) ![Austrian Institute of Technology](./doc/ait.jpg)
## Authors
* Occupancy module
* Jean-Marie Bahu (EIFER)
* Esteban Munoz (Hafen City University)
* Romain Nouvel (HFT Stuttgart)
* Piergiorgio Cipriano (Sinergis)
* Luca Giovannini (Sinergis)
* Core module
* Karl-Heinz Häfele (KIT)
* Joachim Benner (KIT)
* Marcel Bruse(HFT Stuttgart)
* Volker Coors (HFT Stuttgart)
* Robert Kaden (TUM)
* Moritz Lauster (RWTH Aachen)
* Henryk Wolisz (RWTH Aachen)
* Sawsan Mohamed (Universität Stuttgart)
* Romain Nouvel (HFT Stuttgart)
* Piergiorgio Cipriano (Sinergis)
* Luca Giovannini (Sinergis)
* Jean-Marie Bahu (EIFER Karlsruhe)
* Maryam Zirak (HFT Stuttgart)
* Energy Systems module
* Moritz Lauster (RWTH Aachen)
* Peter Remmen (RWTH Aachen)
* Jean-Marie Bahu (EIFER)
* Eric Duminil (HFT Stuttgart)
* Dirk Monien (HFT Stuttgart)
* Diane Perez (EPFL)
* Romain Nouvel (HFT Stuttgart)
* Piergiorgio Cipriano (Sinergis)
* Luca Giovannini (Sinergis)
* Material module
* Karl-Heinz Häfele (KIT)
* Joachim Benner (KIT)
* Enterprise Architect UML model
* Romain Nouvel (HFT Stuttgart)
* Marcel Bruse (HFT Stuttgart)
* Olivier Tournaire (CSTB)
* Joachim Benner (KIT)
* UML model to XSD schema conversion
* Olivier Tournaire (CSTB)
* Sample file
* Marcel Bruse (HFT Stuttgart)
![Special Interest Group 3D](./doc/logos/201309_SIG3D_Logo.png) ![University of Applied Sciences Stuttgart logo](./doc/logos/hft.jpg) ![Technische Universität München logo](./doc/logos/tum.png) ![Karlsruhe Institute für Technologie logo](./doc/logos/kit.jpg)
![RWTH Aachen University / E.ON Energy Research Center logo](./doc/logos/rwth_eon.jpg) ![HafenCityUniversität Hamburg logo](./doc/logos/hcu.png) ![European Institute for Energy Research logo](./doc/logos/eifer.png)
![Ecole Polytechnique Fédérale de Lausanne logo](./doc/logos/epfl.png) ![Centre Scientifique et Technique du Batiment logo](./doc/logos/cstb.png) ![Electricité de France logo](./doc/logos/edf.jpg)
![Sinergis logo](./doc/logos/sinergis.png) ![M.O.S.S Computer Grafik Systeme logo](./doc/logos/moss.jpg) ![Austrian Institute of Technology](./doc/logos/ait.jpg)
<!--
-->
## Guidelines
A document which describes the guidelines can be downloaded from [this link](https://github.com/cstb/citygml-energy/raw/master/guidelines/Guidelines_EnergyADE.pdf). The guidelines can also be read [online](https://github.com/cstb/citygml-energy/blob/master/guidelines/Guidelines_EnergyADE.md).
A document which describes the guidelines can be downloaded from [this link](./doc/guidelines/Guidelines_EnergyADE.pdf). The guidelines can also be read [online](./doc/guidelines/Guidelines_EnergyADE.md).
## UML diagrams
The CityGML Energy ADE currently (v0.5.0) is implemented in a single XSD schema. The following diagrams give an overview of each modules.
### Occupancy module
![Occupancy module](./doc/UML_diagrams/Occupancy.png)
### Building physics module (core)
![Building physics module (core)](./doc/UML_diagrams/BuildingPhysics.png)
### Time series and schedule module (core)
![Time series and schedule module (core)](./doc/UML_diagrams/TimeSeriesAndSchedule.png)
### Energy system module
![Energy system module](./doc/UML_diagrams/EnergySystem.png)
### Material module
![Material module](./doc/UML_diagrams/Material.png)
The CityGML Energy ADE currently (v0.6.0) is implemented in a single XSD schema. [This pdf file](./doc/UML-Diagrams_Energy-ADE.pdf) gives an overview of the class diagrams of the whole model. For more details about the modules, a complete description can be found in the [guidelines](./doc/guidelines/Guidelines_EnergyADE.md).
<!DOCTYPE html
SYSTEM "about:legacy-compat">
<html lang="en">
<!--Created by ShapeChange on 2015-03-12T20:06:47.34+01:00-->
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title> (CityGML Energy ADE application schema)</title>
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style"><script language="javascript" type="text/javascript">function toggle(elementToShowHideById, elementToSwitchTextIn) {
var ele = document.getElementById(elementToShowHideById);
var text = document.getElementById(elementToSwitchTextIn);
if(ele.style.display == "block") {
ele.style.display = "none";
text.innerHTML = "See listed values";
}
else {
ele.style.display = "block";
text.innerHTML = "Hide listed values";
}
}</script><noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</head>
<body>
<h1 id="top">Data type: Absorptance</h1>
<table>
<tr>
<td>
<table>
<tr>
<td>
<p>
<h2>Package:</h2>
</p>
<p class="indent"><a href="../Energy-ADE/package-summary.html">Energy-ADE</a></p>
</td>
</tr>
<tr>
<td>
<p>
<h2>Definition:</h2>
</p>
<p class="indent">Percentaged energy absorptance in different wavelength ranges</p>
</td>
</tr>
<tr>
<td>
<p>
<h2>Type:</h2>
</p>
<p class="indent">Data type</p>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td>
<div>
<p>
<h2>Overview of characteristics:</h2>
</p>
</div><br><div class="indent">
<table class="colored">
<caption>Attributes and association roles</caption>
<tr>
<th>Name</th>
<th>Type</th>
<th>Multiplicity</th>
</tr>
<tr class="odd">
<td><a href="../Energy-ADE/Absorptance.html#_A268_520">percentage</a></td>
<td>Decimal</td>
<td>1</td>
</tr>
<tr class="even">
<td><a href="../Energy-ADE/Absorptance.html#_A268_521">surface</a></td>
<td>SurfaceSide</td>
<td>1</td>
</tr>
<tr class="odd">
<td><a href="../Energy-ADE/Absorptance.html#_A268_522">wavelengthRange</a></td>
<td>WavelengthRangeType</td>
<td>1</td>
</tr>
</table>
</div>
</td>
</tr>
<tr>
<td>
<p>
<h2><a name="_A268_520">Attribute:
</a></h2>
</p>
<p class="small"><a href="#top">back to top</a></p>
<table>
<tr>
<td>
<p class="indent title">Name:
</p>
</td>
<td>
<p>percentage</p>
</td>
</tr>
<tr>
<td>
<p class="indent title">Definition:
</p>
</td>
<td>
<p>Percentage of energy absorptance</p>
</td>
</tr>
<tr>
<td>
<p class="indent title">Voidable:
</p>
</td>
<td>
<p>false</p>
</td>
</tr>
<tr>
<td>
<p class="indent title">Multiplicity:
</p>
</td>
<td>
<p>1</p>
</td>
</tr>
<tr>
<td>
<p class="indent title">Value type:
</p>
</td>
<td>
<p>Decimal</p>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td>
<p>
<h2><a name="_A268_521">Attribute:
</a></h2>
</p>
<p class="small"><a href="#top">back to top</a></p>
<table>
<tr>
<td>
<p class="indent title">Name:
</p>
</td>
<td>
<p>surface</p>
</td>
</tr>
<tr>
<td>
<p class="indent title">Definition:
</p>
</td>
<td>
<p>Wavelength range</p>
</td>
</tr>
<tr>
<td>
<p class="indent title">Voidable:
</p>
</td>
<td>
<p>false</p>
</td>
</tr>
<tr>
<td>
<p class="indent title">Multiplicity:
</p>
</td>
<td>
<p>1</p>
</td>
</tr>
<tr>
<td>
<p class="indent title">Value type:
</p>
</td>
<td>
<p>SurfaceSide (enumeration)</p>
</td>
</tr>
<tr>
<td>
<p class="indent title">Values:
</p>
</td>
<td border="0"><a id="_A268_521_listedValueLink" href="javascript:toggle('_A268_521_listedValueContent','_A268_521_listedValueLink');">See listed values</a><div id="_A268_521_listedValueContent" style="display: none">
<table class="colored">
<tr>
<th>Value Name</th>
<th>Documentation</th>
</tr>
<tr class="odd">
<td>
<p>Inside</p>
</td>
<td></td>
</tr>
<tr class="even">
<td>
<p>Outside</p>
</td>
<td></td>
</tr>
</table>
</div>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td>
<p>
<h2><a name="_A268_522">Attribute:
</a></h2>
</p>
<p class="small"><a href="#top">back to top</a></p>
<table>
<tr>
<td>
<p class="indent title">Name:
</p>
</td>
<td>
<p>wavelengthRange</p>
</td>
</tr>
<tr>
<td>
<p class="indent title">Voidable:
</p>
</td>
<td>
<p>false</p>
</td>
</tr>
<tr>
<td>
<p class="indent title">Multiplicity:
</p>
</td>
<td>
<p>1</p>
</td>
</tr>
<tr>
<td>
<p class="indent title">Value type:
</p>
</td>
<td>
<p>WavelengthRangeType (enumeration)</p>
</td>
</tr>
<tr>
<td>
<p class="indent title">Values:
</p>
</td>
<td border="0"><a id="_A268_522_listedValueLink" href="javascript:toggle('_A268_522_listedValueContent','_A268_522_listedValueLink');">See listed values</a><div id="_A268_522_listedValueContent" style="display: none">
<table class="colored">
<tr>
<th>Value Name</th>
<th>Documentation</th>
</tr>
<tr class="odd">
<td>
<p>Solar</p>
</td>
<td></td>
</tr>
<tr class="even">
<td>
<p>IR</p>
</td>
<td></td>
</tr>
<tr class="odd">
<td>
<p>Visible</p>
</td>
<td></td>
</tr>
<tr class="even">
<td>
<p>Total</p>
</td>
<td></td>
</tr>
</table>
</div>
</td>
</tr>
</table>
</td>
</tr>
</table>
<div class="clearing"></div>
<div id="footer"></div>
</body>
</html>
\ No newline at end of file
<!DOCTYPE html
SYSTEM "about:legacy-compat">
<html lang="en">
<!--Created by ShapeChange on 2015-03-12T20:06:47.34+01:00-->
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title> (CityGML Energy ADE application schema)</title>
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style"><script language="javascript" type="text/javascript">function toggle(elementToShowHideById, elementToSwitchTextIn) {
var ele = document.getElementById(elementToShowHideById);
var text = document.getElementById(elementToSwitchTextIn);
if(ele.style.display == "block") {
ele.style.display = "none";
text.innerHTML = "See listed values";
}
else {
ele.style.display = "block";
text.innerHTML = "Hide listed values";
}
}</script><noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</head>
<body>
<h1 id="top">Feature type: <i>AbstractMaterial</i></h1>
<table>
<tr>
<td>
<table>
<tr>
<td>
<p>
<h2>Package:</h2>
</p>
<p class="indent"><a href="../Energy-ADE/package-summary.html">Energy-ADE</a></p>
</td>
</tr>
<tr>
<td>
<p>
<h2>Definition:</h2>
</p>
<p class="indent">Abstract superclass for all Material classes. A Material is a homogeneous substance
that can be used to form elements.
</p>
</td>
</tr>
<tr>
<td>
<p>
<h2>Subtype of:</h2>
</p>
<p class="indent">_CityObject</p>
</td>
</tr>
<tr>
<td>
<p>
<h2>Supertype of:</h2>
</p>
<p class="indent"><a href="../Energy-ADE/Gas.html">Gas</a></p>
<p class="indent"><a href="../Energy-ADE/Glazing.html">Glazing</a></p>
<p class="indent"><a href="../Energy-ADE/OpaqueMaterial.html">OpaqueMaterial</a></p>
</td>
</tr>
<tr>
<td>
<p>
<h2>Type:</h2>
</p>
<p class="indent">Feature type</p>
</td>
</tr>
<tr>
<td>
<p>
<h2>Abstract:</h2>
</p>
<p class="indent">true</p>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td>
<div>
<p>
<h2>Overview of characteristics:</h2>
</p>
</div><br><div class="indent">
<table class="colored">
<caption>Attributes and association roles</caption>
<tr>
<th>Name</th>
<th>Type</th>
<th>Multiplicity</th>
</tr>
<tr class="odd">
<td><a href="../Energy-ADE/AbstractMaterial.html#_AT621">imageTexture</a></td>
<td><a href="../Energy-ADE/ImageTexture.html">ImageTexture</a></td>
<td>0..1</td>
</tr>
<tr class="even">
<td><a href="../Energy-ADE/AbstractMaterial.html#_A274_534">referenceURI</a></td>
<td>URI</td>
<td>0..*</td>
</tr>
</table>
</div>
</td>
</tr>
<tr>
<td>
<p>
<h2><a name="_AT621">Association role:
</a></h2>
</p>
<p class="small"><a href="#top">back to top</a></p>
<table>
<tr>
<td>
<p class="indent title">Name:
</p>
</td>
<td>
<p>imageTexture</p>
</td>
</tr>
<tr>
<td>
<p class="indent title">Definition:
</p>
</td>
<td>
<p>Reference to a texture file</p>
</td>
</tr>
<tr>
<td>
<p class="indent title">Voidable:
</p>
</td>
<td>
<p>false</p>
</td>
</tr>
<tr>
<td>
<p class="indent title">Multiplicity:
</p>
</td>
<td>
<p>0..1</p>
</td>
</tr>
<tr>
<td>
<p class="indent title">Value type:
</p>
</td>
<td>
<p><a href="../Energy-ADE/ImageTexture.html">ImageTexture</a> (feature type)
</p>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td>
<p>