diff --git a/README.md b/README.md index 7c59feaadaba19be9d0e09279af723a83092682d..4499487297f0f576ff5bcaf24e75a2ba05f5f3d8 100644 --- a/README.md +++ b/README.md @@ -1,26 +1,59 @@ -# Energy ADE (ver 2 beta 7) module for citygml4j - Work in Progress +# Energy ADE (ver 2 beta 7) module for citygml4j v2.13.1- Work in Progress [Java 17](https://bell-sw.com/pages/downloads/#jdk-17-lts) is the minimum requirement. This is a citygml4j module for the **Energy Application Domain Extension** (Energy ADE) v2 beta7 for CityGML. -:information_source: The Energy ADE 2 (beta 7) module is intended to be used with CityGMl v2 and its [citygml4j v2](https://github.com/citygml4j/citygml4j/tree/citygml4j-v2) -and works fine in this context. However, note that citygml4j v2 is in _maintenance mode_. There are -currently _no plans to migrate_ the Energy ADE 2 module to citygml4j v3 or CityGML 3 +The Energy ADE 2 (beta 7) module is intended to be used with CityGMl v2 and its [citygml4j v2](https://github.com/citygml4j/citygml4j/tree/citygml4j-v2) +and works fine in this context. However, note that citygml4j v2 is in _maintenance mode_. This library adds support for parsing and writing CityGML data and enables developers to work with 3D city models as a set of Java objects. -Priority List: +Currently, there are _no plans to migrate_ the Energy ADE 2 citygml4j module to citygml4j v3 or add support for 3DCityDB v5 or CityGML v3 or CityJSON. -- Timeseries -- DataType -- Core +The following modules are supported at the moment: + +- Core (AbstractBuilding, Refurbishment Measures) - Resource - UrbanFunctionArea - WeatherStation +- Timeseries +- DataTypes + +The following modules are currently in development: + +- Core (remaining classes) +- BuildingPhysics +- Occupancy - Layered Construction - Schedule - Devices -- BuildingPhysics -- Occupancy + +The Energy ADE 2 module for citygml4j uses [Gradle](https://gradle.org/) as build system. + +Click [here](https://transfer.hft-stuttgart.de/gitlab/energy-ade/energy-ade-2-3dcitydb) for the importer/exporter API module of Energy ADE 2 supporting 3DCityDB v4.x.x. + +Please refer to the main repository of [Energy ADE 2](https://github.com/tudelft3d/Energy_ADE) for more details. + +# Contact person: + +- Rushikesh Padsala - rushikesh.padsala@hft-stuttgart.de + +# Main developers and contributors + +- Prabitha Prabhakaran (HFT Stuttgart, Germany): Main developer +- Rushikesh Padsala (HFT Stuttgart, Germany): Main developer +- Matthias Betz (HFT Stuttgart, Germany): Contributor + +# Acknowledgements +- Prof. Dr. Giorgio Agugiaro (TU Delft, Netherlands) +- Prof. Dr. Volker Coors (HFT Stuttgart, Germany) + +# License + +The software resources available on this repository adopt the [Apache License 2.0](https://www.apache.org/licenses/LICENSE-2.0). + +# Funding + +The development of the Energy ADE 2.0 (led by TU Delft) started in spring 2024 within the European [DigiTwins4PEDs](https://digitwins4peds.eu/) project. The project is funded by the Federal Ministry for Economic Affairs and Climate Protection (BMWK) for the project DigiTwins4PEDs (case study: Stuttgart) as part of the [Driving Urban Transition - DUT](https://dutpartnership.eu/) partnership, which is co-financed by the European Commission (Funding Indicator:03EN3081A). The project is part of the DUT 2022 call which also contributes to the Urban Transition Mission of Mission Innovation as part of the MICall 2022 initiative. diff --git a/build.gradle b/build.gradle index 2d3e6802ab0405396dda6e0153ec4bb287902e27..e83fe93e8d8807841016d53f560b406bfab21b34 100644 --- a/build.gradle +++ b/build.gradle @@ -18,8 +18,8 @@ java { allprojects { group 'org.citygml4j.ade' - version 'beta7' - description 'CityGML EnergyADE v2beta7 module for citygml4j' + version 'beta7-0.1' + description 'CityGML EnergyADE v2beta7 module for citygml4j - release 0.1' ext { citygml4jVersion = '2.13.1' @@ -90,7 +90,7 @@ distributions.main.contents { version: project.version, date: date.format('yyyy-MM-dd'), copyright: date.format('yyyy'), - javaCompatibility: '11', + javaCompatibility: '17', citygml4jVersion: citygml4jVersion ]) }