Spectral BY SODA automatic access:  PAR, uv & kato bands

Last update: Oct. 2019

 

   

Automatic access is only available to users who subscribed to Spectral by SoDa requests

For a quotation, please contact us

Automatic access to satellite-derived solar radiation database spectral radiation values.

Three spectral bands are available: Photosynthetically Active Radiation (PAR), Ultra-Violet (UV) and Kato Interval data. 

This type of access is particularly well-suited for monitoring applications or to launch many requests on a non-regular grid of points.

Automatic access using WGET - using CURL - Download examples

Download WGET.EXE

   

 

Warning! It is strongly recommended to avoid the launch of parallel requests, using the "&" at the end of each wget request line. This would endanger our system.

 

I. Automatic access using WGET

  1. Subscribe an annual access to Spectral by SoDa service (Contact us)
  2. Download wget.exe in a directory (on Windows - wget is available by default on Unix)
  3. In the same directory, create a text file and copy-paste in a single line (discard dots and carriage return) the following instruction to test this permanent access to Carpentras, France:
 

wget -O output.csv  --header="soda-user: guest" --header="soda-passwd: guest" "http://www.soda-is.com/pub/ ...
spectral_by_soda_request.php?geopoint=44.083,5.059&elevation=-999&firstday=2012-12-01&lastday=2012-12-31&duration=h ...

&horizon=1&spectralband=kato&katointerval=9,10"

  1. Rename the text file with the .bat extension and double click on it to retrieve the output.csv output file (Windows environment). Or, rename the text file with a .sh extension and run it using >my_script.sh in a Unix environment.

 

UV DATA

(Click on the following links to show the tutorials)

UV automatic command with inputs to fill in

 

(discard dots and place the following commands into a single line)

 

wget -O output.csv  --header="soda-user: login" --header="soda-passwd: password" "http://server/pub/ ...
spectral_by_soda_request.php?geopoint=latitude,longitude&elevation=altitude&firstday=yyyy-mm-dd&lastday=yyyy-mm-dd ...

&duration=time_step&spectralband=UV&horizon=activate_horizon_computation"

 

UV inputs details  

 

  • login/password authentication: login and password provided by the SoDa team to access Spectral by SoDa within the framework of your subscription. Note that a free permanent automatic access is set up for the site of Carpentras, France, with the login/password guest/guest
  • server: "www.soda-is.com" (main server) or "pro.soda-is.com" (mirror server)
  • latitude and longitude: in degrees, with at least 4 digits after comma
  • altitude: in meters. Set "elevation=-999" to let SoDa get the elevation from Nasa SRTM database
  • yyyy-mm-dd: set the first and the last days of the request
  • time_step: "1", "5", "10", "15" (minutes), "h" (hourly), "d" (daily), "m" (monthly)
  • activate_horizon_computation: "1" (or "0") to take into account (or not) the shadowing effect due to the far horizon.

 

UV example

 

(discard dots and place the following commands into a single line)

 

wget -O output.csv  --header="soda-user: guest" --header="soda-passwd: guest" "http://www.soda-is.com/pub/ ...
spectral_by_soda_request.php?geopoint=44.083,5.059&elevation=-999&firstday=2012-12-01&lastday=2012-12-31 ...

&duration=h&spectralband=UV&horizon=1"

 

UV outputs

 

  1. Date: format DD-MM-YYYY
  2. Time: format hh:mm
  3. UVB GHI (Wh/m2): Irradiation in UV-B (280-315 nm) over the period on horizontal plane (-999 if no data or outside MSG coverage)
  4. UVB Gc clear-sky (Wh/m2): Irradiation in UV-B (280-315 nm) over the period on horizontal plane if the sky was clear (-999 if no data)
  5. UVB TOA (Wh/m2): Irradiation in UV-B (280-315 nm) over the period at the Top of the Atmosphere (-999 if no data)
  6. UVA GHI (Wh/m2): Irradiation in UV-A (315-400 nm) over the period on horizontal plane (-999 if no data or outside MSG coverage)
  7. UVA Gc clear-sky (Wh/m2): Irradiation in UV-A (315-400 nm) over the period on horizontal plane if the sky was clear (-999 if not data)
  8. UVA TOA (Wh/m2): Irradiation in UV-A (315-400 nm) over the period at the Top of the Atmosphere (-999 if not data)
  9. UV GHI (Wh/m2): Irradiation in UV (280-400 nm) over the period on horizontal plane (-999 if no data or outside MSG coverage)
  10. UV Gc clear-sky (Wh/m2): Irradiation in UV (280-400 nm) over the period on horizontal plane if the sky was clear (-999 if no data)
  11. UV TOA (Wh/m2): Irradiation in UV (280-400 nm) over the period at the Top of the Atmosphere (-999 if no data)
  12. The reliability column has several forms depending of the time step:

    • Code: 0: no data, 1: sun below horizon, 2: satellite assessment, 5: interpolation in time, 6: forecast
    • Nb slots (%): ratio of the number of valid slots and the number of slots during the daylength in percent
    • Nb valid days: number of valid days in the period

 

PAR DATA

(Click on the following links to show the tutorials)

PAR automatic command with inputs to fill in

 

(discard dots and place the following commands into a single line)

 

wget -O output.csv  --header="soda-user: login" --header="soda-passwd: password" "http://server/pub/ ...
spectral_by_soda_request.php?geopoint=latitude,longitude&elevation=altitude&firstday=yyyy-mm-dd&lastday=yyyy-mm-dd ...

&duration=time_step&spectralband=PAR&horizon=activate_horizon_computation"

 

PAR inputs details  

 

  • login/password authentication: login and password provided by the SoDa team to access Spectral by SoDa within the framework of your subscription. Note that a free permanent automatic access is set up for the site of Carpentras, France, with the login/password guest/guest
  • server: "www.soda-is.com" (main server) or "pro.soda-is.com" (mirror server)
  • latitude and longitude: in degrees, with at least 4 digits after comma
  • altitude: in meters. Set "elevation=-999" to let SoDa get the elevation from Nasa SRTM database
  • yyyy-mm-dd: set the first and the last days of the request
  • time_step: "1", "5", "10", "15" (minutes), "h" (hourly), "d" (daily), "m" (monthly)
  • activate_horizon_computation: "1" (or "0") to take into account (or not) the shadowing effect due to the far horizon.

 

PAR example

 

(discard dots and place the following commands into a single line)

 

wget -O output.csv  --header="soda-user: guest" --header="soda-passwd: guest" "http://www.soda-is.com/pub/ ...
spectral_by_soda_request.php?geopoint=44.083,5.059&elevation=-999&firstday=2012-12-01&lastday=2012-12-31 ...

&duration=h&spectralband=PAR&horizon=1"

 

PAR outputs

 

  1. Date: format DD-MM-YYYY
  2. Time: format hh:mm
  3. PAR GHI (µmol/m2/s): PAR (400-700 nm) over the period on horizontal plane (-999 if no data or outside MSG coverage)
  4. PAR Gc clear-sky (µmol/m2/s): PAR (400-700 nm) over the period if the sky was clear (-999 if no data)
  5. PAR TOA (µmol/m2/s): PAR (400-700 nm) over the period at the Top of the Atmosphere (-999 if no data)
  6. The reliability column has several forms depending of the time step:

    • Code: 0: no data, 1: sun below horizon, 2: satellite assessment, 5: interpolation in time, 6: forecast
    • Nb slots (%): ratio of the number of valid slots and the number of slots during the daylength in percent
    • Nb valid days: number of valid days in the period

 

KATO BANDS

(Click on the following links to show the tutorials)

KATO automatic command with inputs to fill in

 

(discard dots and place the following commands into a single line)

 

wget -O output.csv  --header="soda-user: login" --header="soda-passwd: password" "http://server/pub/ ...
spectral_by_soda_request.php?geopoint=latitude,longitude&elevation=altitude&firstday=yyyy-mm-dd&lastday=yyyy-mm-dd ...

&duration=time_step&horizon=activate_horizon_computation&spectralband=kato&katointerval=KatoLowerBound,KatoUpperBound"

 

KATO inputs details

 

  • login/password authentication: login and password provided by the SoDa team to access Spectral by SoDa within the framework of your subscription. Note that a free permanent automatic access is set up for the site of Carpentras, France, with the login/password guest/guest
  • server: "www.soda-is.com" (main server) or "pro.soda-is.com" (mirror server)
  • latitude and longitude: in degrees, with at least 4 digits after comma
  • altitude: in meters. Set "elevation=-999" to let SoDa get the elevation from Nasa SRTM database
  • yyyy-mm-dd: set the first and the last days of the request
  • time_step: "1", "5", "10", "15", "30" (minutes), "h" (hourly), "d" (daily), "m" (monthly)
  • activate_horizon_computation: "1" (or "0") to take into account (or not) the shadowing effect due to the far horizon
  • KatoLowerBound and KatoUpperBound: the first and last band of Kato band interval.

 

KATO example

 

(discard dots and place the following commands into a single line)

 

wget -O output.csv  --header="soda-user: guest" --header="soda-passwd: guest" "http://www.soda-is.com/pub/ ...
spectral_by_soda_request.php?geopoint=44.083,5.059&elevation=-999&firstday=2012-12-01&lastday=2012-12-31 ...

&duration=h&horizon=1&spectralband=kato&katointerval=9,10"

KATO outputs

 

  1. Date: format DD-MM-YYYY
  2. Time: format hh:mm
  3. Kato[i] (Wh/m2): Irradiation over the period on horizontal plane for the ith Kato band (-999 if no data or outside MSG coverage)
  4. Kato[i] clear-sky (Wh/m2): Irradiation over the period if the sky was clear for the ith Kato band (-999 if no data)
  5. Kato[i] TOA (Wh/m2): Irradiation over the period at the Top of the Atmosphere for the ith Kato band (-999 if no data)
  6. The reliability column has several forms depending of the time step:

    • Code: 0: no data, 1: sun below horizon, 2: satellite assessment, 5: interpolation in time, 6: forecast
    • Nb slots (%): ratio of the number of valid slots and the number of slots during the daylength in percent
    • Nb valid days: number of valid days in the period

 

II. Automatic access using CURL

You can also automatically retrieve these data using the CURL command. The advantage is to fasten the requests by an approx. factor of 2. Note that all characteristics (inputs and outputs) described in the WGET section are valid for CURL, except that CURL outputs don't have any header.

Request (Windows):


curl -f -s -S -F stations=@stations.txt -o output.csv --header "soda-user: guest" ...
--header "soda-passwd: guest" http://www.soda-is.com/pub/spectral_by_soda_request.php

 

With the following stations.txt file format:

 

# Spectral by SoDa station file for curl.
# Each line describes the parameters of one Spectral from Helioclim 3 request.
# More details at http://www.soda-pro.com/help/automatic-access/spectral-by-soda
#
# Columns:
# id: station name
# latitude and longitude: in degrees, with at least 4 digits after comma
# elevation: in meters. Use -999 to let SoDa get the elevation from Nasa SRTM database.
# duration: "1", "5", "10", "15", "30" (minutes), "h" (hourly), "d" (daily), "m" (monthly)
# firstday and lastday: first and the last days of the request, expressed as yyyy-mm-dd
# spectral_band: "PAR" or "UV" or "KATO=KatoLowerBound,KatoUpperBound"
# activate_horizon_computation: "0" to ignore relief shadows, "1" or "SRTM" for an horizon computed from SRTM

#id latitude longitude elevation duration firstday lastday spectral_band activate_horizon_computation
UV-id1                47.41       8.53         450          h            2004-04-15    2004-04-15    UV              0
UV-id2                10          5            -999         h            2004-04-15    2004-04-15    uv              1
PAR-id3               0           0            0            h            2004-04-15    2004-04-15    par             0
PAR-id4               10          5            -999         h            2004-04-15    2004-04-15    par             1
KATO-id5              10          5            -999         h            2004-04-15    2004-04-15    KATO=3,5        0
KATO-singleband-id6   10          5            -999         h            2004-04-15    2004-04-15    KATO=8          0


 

III. Download examples of wget and curl scripts

 

Download examples here!