View source for Radolan

{{OsProject|id=com.bitplan.radolan|owner=BITPlan|title=Java port of Radolan parser|url=https://github.com/BITPlan/com.bitplan.radolan|version=0.0.2|date=2018-11-02}}
ported from golang version https://gitlab.cs.fau.de/since/radolan
= RADOLAN = 
RADOLAN is the [https://de.wikipedia.org/wiki/Niederschlagsradar German Rainradar] system of [http://www.dwd.de Deutscher Wetterdienst]
== DWD Information on RADOLAN ==
[[File:Dwd logo 258x69.png|left|link=https://www.dwd.de]]
* [https://www.dwd.de/DE/leistungen/radolan/radolan_info/home_freie_radolan_kartendaten.html Frei verfügbare RADOLAN-Daten und deren aktuelle Visualisierung: Stundensumme RW (links) und Tagessumme SF (rechts)]
* [https://www.dwd.de/DE/leistungen/radolan/radolan Analysen radarbasierter stündlicher (RW) und täglicher (SF) Niederschlagshöhen ]
* [https://www.dwd.de/DE/leistungen/radolan/radolan_alt RADOLAN (Radar-Online-Aneichung)]
see also {{Link|target=#Documents|title=Document list below}}

== DWD Radolan Opendata == 
* https://opendata.dwd.de/weather/radar/radolan/
** [https://opendata.dwd.de/weather/radar/radolan/sf/ radolan/sf daily sum - in hour steps for the previous 48 hours]
** [https://opendata.dwd.de/weather/radar/radolan/rw/ radolan/rw hourly sum - in hour steps for the previous 48 hours]
** [https://opendata.dwd.de/weather/radar/radolan/ry/ radolan/ry - in 5 minute steps for the previous 24 hours]
* ftp://ftp-cdc.dwd.de/pub/CDC/grids_germany/daily/radolan
** [ftp://ftp-cdc.dwd.de/pub/CDC/grids_germany/daily/radolan/recent/ recent daily]
** [ftp://ftp-cdc.dwd.de/pub/CDC/grids_germany/daily/radolan/historical/ historical]

The data is stored in proprietary file formats based on [https://en.wikipedia.org/wiki/Fortran Fortran] conventions.
As of 2018-08 we did not find an open source [https://en.wikipedia.org/wiki/Java_(programming_language) Java] library to read these formats so [http://www.bitplan.com BITPlan] decided to make one available. Fortunaly Jonny Schäfer created a [https://gitlab.cs.fau.de/since/radolan golang RADOLAN library] that was quite easy to port/migrate.

The above two urls are considered "known urls" by the Radolan Java Library and access to these will lead to local caching of the data.

= First Steps =
== Prerequisites ==
* [http://www.oracle.com/technetwork/java/javase/downloads/jre8-downloads-2133155.html Oracle Java Runtime 8]
or if you'd like to build the Radolan software yourself:
* [http://www.oracle.com/technetwork/pt/java/javase/downloads/jdk8-downloads-2133151.html Oracle Java Development Kit 8 ]
* [https://maven.apache.org/install.html Maven 3]

== Downloads ==
* [https://github.com/BITPlan/com.bitplan.radolan/blob/master/release/radolan.jar?raw=true radolan.jar] - multiplatform Java
* [https://github.com/BITPlan/com.bitplan.radolan/blob/master/release/radolan.exe?raw=true radolan.exe] - Windows executable
== Installation ==
Make sure the {{Link|target=#Prerequisites|title=prerequisites}} are checked.
Download the software for your platform from {{Link|target=#Downloads}}
or {{Link|target=#Build|title=build}} the software yourself

== Starting ==
Run the software with <source lang='bash'>java -jar radolan.jar</source> or <nowiki>radolan</nowiki> (If you built the software yourself: <nowiki>cd com.bitplan.radolan/release</nowiki> before this command).

= Examples =
== Radar film ==
Calling radolan with no arguments will show the current DWD radar film
https://www.dwd.de/DWD/wetter/radar/radfilm_brd_akt.gif
<source lang='bash'>
java -jar release/radolan.jar
</source>
which is equivalent to
<source lang='bash'>
java -jar release/radolan.jar -i https://www.dwd.de/DWD/wetter/radar/radfilm_brd_akt.gif
</source>
== Radar snapshot ==
https://www.dwd.de/DWD/wetter/radar/rad_brd_akt.jpg
<source lang='bash'>
java -jar release/radolan.jar -i https://www.dwd.de/DWD/wetter/radar/rad_brd_akt.jpg
</source>

== Daily summary (SF) ==
The picture below renders the https://opendata.dwd.de/weather/radar/radolan/sf/raa01-sf_10000-latest-dwd---bin radolan SF file as of 2018-08-18 19:50.

[[File:2018-08-18_1950.png|600px]]

The command to create this picture was:
<source lang='bash'>
java -jar radolan.jar -i https://opendata.dwd.de/weather/radar/radolan/sf/raa01-sf_10000-latest-dwd---bin -o 2018-08-18_1950.png -st 5
</source>
* <nowiki>-i</nowiki> specified the input url
* <nowiki>-o</nowiki> specified the output image
* <nowiki>-st</nowiki> specified the number of seconds the image should be shown

== Hourly sum (RW) ==
The picture belows renders the https://opendata.dwd.de/weather/radar/radolan/rw/raa01-rw_10000-latest-dwd---bin file as of 2018-08-17 08:50

[[File:rw2018-08-17_0850.png|600px]]

The command to create the picture was:
<source lang='bash'>
java -jar radolan -i https://opendata.dwd.de/weather/radar/radolan/rw/raa01-rw_10000-1808170650-dwd---bin -o rw2018-08-17_0850.png -st 5
</source>

== Historical data (SF) ==
The picture below renders the ftp://ftp-cdc.dwd.de/pub/CDC/grids_germany/daily/radolan/recent/raa01-sf_10000-1805301650-dwd---bin.gz SF files as of 2018-05-30 16:50

[[File:sf-2018-05-30_1650.png|600px]]

The command to create this picture was:
<source lang='bash'>
java -jar radolan.jar -i ftp://ftp-cdc.dwd.de/pub/CDC/grids_germany/daily/radolan/recent/raa01-sf_10000-1805301650-dwd---bin.gz -o sf-2018-05-30_1650.png -st 5
</source>

= Usage =

== Commandline Arguments ==
<source lang='bash'>
java -jar release/radolan.jar -h
Help
Radolan: 0.0.1

  usage: java Radolan
 -b (--borderName) WERT : borderName
                           (Vorgabe: 2_bundeslaender/2_hoch.geojson)
 -cp (--cachePath) WERT : path to Cache
                          the path to the Cache (Vorgabe: /Users/wf/.radolan)
 -d (--debug)           : debug
                          create additional debug output if this switch is used
                          (Vorgabe: false)
 -h (--help)            : help
                          show this usage (Vorgabe: true)
 -i (--input) WERT      : input
                          url/file of the input
 -l (--location) WERT   : location/show data at the given location
 -nc (--noCache)        : noCache
                          do not use local cache (Vorgabe: false)
 -o (--output) WERT     : output/e.g. path of png/jpg/gif file
 -p (--product) WERT    : product e.g. SF,RW,RY or alias daily,hourly,5min
                          (Vorgabe: sf)
 -s (--show)            : show
                          show resulting image (Vorgabe: true)
 -st (--showTime) N     : showTime
                          show result for the given time in seconds (Vorgabe:
                          1952257)
 -v (--version)         : showVersion
                          show current version if this switch is used (Vorgabe:
                          false)
 -z (--zoom) N          : zoom/zoom to a grid size of zxz km (Vorgabe: 30.0)
</source>

== Interactive Usage ==
When you hover over a picture the location and amount of precipitation at the given position will be
displayed as a tooltip.

[[File:radolan_hover_2018-08-16.png|550px]]
== Issues ==
Please report any issues via
* https://github.com/BITPlan/com.bitplan.radolan/issues

= Development =
== Using with Maven ==
<source lang='xml'>
<dependency>
  <groupId>com.bitplan.radolan</groupId>
  <artifactId>com.bitplan.radolan</artifactId>
  <version>0.0.1</version>
</dependency>
</source>
== Build ==
<source lang='bash'>
git clone https://github.com/BITPlan/com.bitplan.radolan
cd com.bitplan.radolan
mvn install -D skipTests
</source>
The resulting jar and exe files are in the release subdirectory.

== Test ==
<source lang='bash'>
cd com.bitplan.radolan
mvn test
...
Results :

Tests run: 28, Failures: 0, Errors: 0, Skipped: 0
</source>

== Libraries used ==
* {{Link|target=Com.bitplan.javafx}}

== Limitations ==
This java port of https://gitlab.cs.fau.de/since/radolan is not fully complete yet.
E.g. the RunLength and SingleByte Encodings have not been ported yet. You are welcome to send a pullrequest to incorporate this functionality or ask for help via [http://www.bitplan.com/index.php/Kontaktformular BITPlan's contact form]

= Credits/ Copyrights =
== Jonny Schäfer ==
Thanks to Jonny Schäfer of the Computer Science Department of [https://www.fau.de/ Friedrich-Alexander-Universität Erlangen-Nürnberg (FAU)] for the [https://gitlab.cs.fau.de/since/radolan golang radolan implementation] on which this project is based.
== DWD ==
[[File:Dwd logo 258x69.png|left|link=https://www.dwd.de]]
This project is based on copyrighted and open sourced material from [https://www.dwd.de Deutscher Wetterdienst]. You may only use it in conformance with
* [https://www.dwd.de/DE/service/copyright/copyright_artikel.html?nn=16102&lsbId=617848 DWD Copyright]

= Links =
== Documents ==
# https://www.dwd.de/DE/leistungen/radolan/radolan_info/radolan_radvor_op_komposit_format_pdf.pdf
# https://www.dwd.de/DE/leistungen/gds/weiterfuehrende_informationen.zip
#  - legend_radar_products_fz_forecast.pdf
#  - legend_radar_products_pg_coordinates.pdf
#  - legend_radar_products_radolan_rw_sf.pdf
# [https://www.dwd.de/DE/leistungen/radarniederschlag/rn_info/download_niederschlagsbestimmung.pdf Niederschlagsbestimmung ]
# [https://www.dwd.de/DE/leistungen/radolan/produktuebersicht/radolan_produktuebersicht_pdf.pdf?__blob=publicationFile&v=6 RADOLAN Produktübersicht]
== Papers ==
# [https://www.researchgate.net/profile/Simon_Jaeckel/publication/306239345_Wetterradar_-_Anwendungen_und_neue_Entwicklungen_Tagungsband_zum_VDI-Expertenforum_23102013_Bonn/links/57b42d0a08aeaab2a1038253/Wetterradar-Anwendungen-und-neue-Entwicklungen-Tagungsband-zum-VDI-Expertenforum-23102013-Bonn.pdf Wetterradar Anwendungen und neue Entwicklungen - VDI Expertenform 2013-10-23 Bonn - PDF]

== Radolan Infos ==
see [https://www.dwd.de/DE/leistungen/radolan/radolan_info/radolan_informationen.html?lsbId=617848 Radolan Infos Overview]
=== 2005 ===
#{{RadolanInfo|1|18.01.2005}}
#{{RadolanInfo|2|18.05.2005}}
=== 2007 ===
#{{RadolanInfo|3|26.06.2007}}
#{{RadolanInfo|4|06.07.2007}}
#{{RadolanInfo|5|17.07.2007}}
#{{RadolanInfo|6|09.11.2007}}
#{{RadolanInfo|7|21.11.2007}}
#{{RadolanInfo|8|23.11.2007}}
#{{RadolanInfo|9|28.12.2007}}

=== 2009 ===
#{{RadolanInfo|10|18.05.2009}}
#{{RadolanInfo|11|28.05.2009}}
=== 2010 ===
#{{RadolanInfo|12|15.02.2010}}
#{{RadolanInfo|13|03.03.2010}}
#{{RadolanInfo|14|05.03.2010}}
#{{RadolanInfo|15|25.03.2010}}
#{{RadolanInfo|16|30.04.2010}}
#{{RadolanInfo|17|09.07.2010}}
=== 2011 ===
#{{RadolanInfo|18|07.02.2011}}
#{{RadolanInfo|19|16.02.2011}}
#{{RadolanInfo|20|06.04.2011}}
#{{RadolanInfo|21|01.06.2011}}

=== 2012 ===
#{{RadolanInfo|22|11.01.2012}}
#{{RadolanInfo|23|13.04.2012}}
#{{RadolanInfo|24|21.11.2012}}
#{{RadolanInfo|25|14.12.2012}}

=== 2013 ===
#{{RadolanInfo|26|04.04.2013}}
#{{RadolanInfo|27|17.06.2013}}
#{{RadolanInfo|28|20.06.2013}}
#{{RadolanInfo|29|05.07.2013}}
#{{RadolanInfo|30|30.08.2013}}
#{{RadolanInfo|31|01.10.2013}}
#{{RadolanInfo|32|31.10.2013}}
#{{RadolanInfo|33|10.12.2013}}
#{{RadolanInfo|34|19.12.2013}}

=== 2014 ===
#{{RadolanInfo|35|24.01.2014}}
#{{RadolanInfo|36|31.03.2014}}
#{{RadolanInfo|37|03.06.2014}}
#{{RadolanInfo|38|08.10.2014}}
#{{RadolanInfo|39|14.11.2014}}
=== 2015 ===
#{{RadolanInfo|40|02.04.2015}}
=== 2016 ===
#{{RadolanInfo|41|02.09.2016}}

=== 2017 ===
#{{RadolanInfo|42|01.02.2017}}
#{{RadolanInfo|43|04.09.2017}}
#{{RadolanInfo|44|13.09.2017}}
#{{RadolanInfo|45|25.10.2017}}
=== 2018 ===
#{{RadolanInfo|46|27.02.2018|POLARA}}
#{{RadolanInfo|47|25.04.2018|POLARA}}

== Other Libraries ==
* [https://gitlab.cs.fau.de/since/radolan golang Library by Jonny Schäfer of Friedrich-Alexander-Universität Erlangen-Nürnberg (FAU)]
* [https://wradlib.org/ wradlib An Open Source Library for Weather Radar Data Processing]
* [https://github.com/jkreklow/radproc Python Library by Jennifer Kreklow University of Hannover]
* [https://github.com/meteo-ubonn/radolan Radolan C++ Library by University of Bonn]
* [https://github.com/brry/rdwd#rdwd rdwd R package] by [https://github.com/brry Berry Boessenkool]
[[Category:frontend]]