Merge pull request #2018 from ibpsa/issue2017_AixWeatherInfo

mwetter · web-flow · commit eb689494d388 · 2025-06-04T01:19:18.000-07:00
Update doc on how to get .mos data #2017
diff --git a/IBPSA/BoundaryConditions/WeatherData/ReaderTMY3.mo b/IBPSA/BoundaryConditions/WeatherData/ReaderTMY3.mo
@@ -1256,35 +1256,59 @@ The following variables serve as output and are accessible via <code>weaBus</cod
 </tr>
 </table>
 <!-- ============================================== -->
-<h4>Adding new weather data</h4>
+<h4>Using new weather data</h4>
 <p>
-To add new weather data, proceed as follows:
+To use new weather data, there are two supported ways:
+</p>
+<ul>
+<li>
+<p>
+You can use the Python tool AixWeather
+(<a href=\"https://github.com/RWTH-EBC/AixWeather\">https://github.com/RWTH-EBC/AixWeather</a>),
+which is installable via <code>pip</code> or accessible via a WebApp (<a href=\"https://aixweather.eonerc.rwth-aachen.de/\">https://aixweather.eonerc.rwth-aachen.de/</a>).
+Here, conversion of <code>epw</code> (EnergyPlus), <code>dat</code> (German Meteorological Service) or custom data 
+to the desired <code>mos</code> format is supported.
+</p>
+</li>
+<li>
+<p>
+You can use a Java application to convert <code>epw</code> to <code>mos</code> format by following these steps:
 </p>
 <ol>
 <li>
+<p>
 Download the weather data file with the <code>epw</code> extension from
 <a href=\"http://energyplus.net/weather\">
 http://energyplus.net/weather</a>.
+</p>
 </li>
 <li>
+<p>
 Add the file to <code>IBPSA/Resources/weatherdata</code> (or to any directory
 for which you have write permission).
+</p>
 </li>
 <li>
-On a console window, type<pre>
+<p>
+On a console window, type</p><pre>
   cd IBPSA/Resources/weatherdata
   java -jar ../bin/ConvertWeatherData.jar inputFile.epw
 </pre>
-  if inputFile contains space in the name:
+<p>
+or if <code>inputFile.epw</code> contains space in the name:
+</p>
 <pre>
   java -jar ../bin/ConvertWeatherData.jar \"inputFile .epw\"
 </pre>
+<p>
 This will generate the weather data file <code>inputFile.mos</code>, which can be read
 by the model
 <a href=\"modelica://IBPSA.BoundaryConditions.WeatherData.ReaderTMY3\">
 IBPSA.BoundaryConditions.WeatherData.ReaderTMY3</a>.
+</p>
 </li>
 </ol>
+</ul>
 <!-- ============================================== -->
 <h4>Location data that are read automatically from the weather data file</h4>
 <p>
@@ -1598,6 +1622,12 @@ Technical Report, NREL/TP-581-43156, revised May 2008.
 </html>", revisions="<html>
 <ul>
 <li>
+May 28, 2025, by Fabian Wuellhorst:<br/>
+Added information on AixWeather to documentation.<br/>
+This is for
+<a href=\"https://github.com/ibpsa/modelica-ibpsa/issues/2017\">IBPSA, #2017</a>.
+</li>
+<li>
 September 6, 2021, by Ettore Zanetti:<br/>
 Changed alt and lat to real inputs.<br/>
 This is for
