Debian Codegraph @

settings/sentineldl.conf.example

raw
1 # Config file for downloading Sentinel 2 data from SciHub using sentinelsat.
2 #
3 # sentineldl searches for /etc/sentineldl and settings/ (in this order) and
4 # assumes the first that exists to hold the configuration files. All files in
5 # any subfolder that match *.conf are used config files and merged.
6 #
7 # Settings may be stored in one file or across several files possibly in sub
8 # direcotries. Each file has to be a valid ini file and section names have to
9 # be unique across all files. See:
10 # https://docs.python.org/3.5/library/configparser.html#supported-ini-file-structure
11 # Exactly one hierarchy level of sections is allowed.
12
13 # A valid configuration must at least contain the sections "global" and
14 # "credentials". Any section with another name is treated as region for
15 # downloading data (see below).
16
17 # global
18 # ======
19 # This section is mandatory.
20 [global]
21 # This section should hold the platformname and the directory where the
22 # data should be downloaded to.
23
24 # "platformname" can only have the value "Sentinel-2" at the moment
25 # (requirement by sentinelsat).
26 platformname = 'Sentinel-2'
27
28 # The following keys configure the download location and storage layout.
29 # Data is downloaded to:
30 # 'base_dest'/'product_type'/'orig'
31
32 # "base_dest" is the root that sentineldl uses for downlading the data.
33 # Within base_dest sentineldl will create the folders necessary to
34 # hold the downloaded data. Currently the following layout is used:
35 # <base_dest>/<product_type>/<granuleid>/<year>
36 # The storage layout cannot be configured.
37 #
38 # Use the 'data' to run the script without installation.
39 base_dest = data
40
41 # see below for the 'product_type'
42
43 # The name of the folder containing the raw downloaded data
44 # WARNING: If you change this, you have to manually change the processing
45 # scripts.
46 downloaded_files = orig
47
48 # credentials
49 # ===========
50 # This section is mandatory.
51
52 #[credentials]
53 # username = theusername
54 # password = thepassword
55
56
57 # other sections
58 # ==============
59 # Other sections may configure a region and a timespan that should be
60 # downloaded. The section names are arbitrary and not used during execution of
61 # sentineldl. Valid keys are "clouds_max", "clouds_min", "date_end",
62 # "date_start", "footprint", "product_type".
63 #
64 # Cloud coverage
65 # --------------
66 # Percentace of accepted cloud cover 0 - 100
67 #
68 # Dates
69 # -----
70 # Images between the dates specified will be searched.
71 # Expects a date formatted as yyyy-mm-dd. date_end also
72 # accepts a string 'today'. Note that it does not make sense to download data
73 # before 2016-12-01 using this script as the storage formate was different
74 # before and does not fit sentineldl's storage system.
75 #
76 # footprint
77 # ---------
78 # The filename of a geojson file containing a geometry of the region that should
79 # be downloaded. The path of the file must be relative to the conf-file that
80 # references it.
81 #
82 # The follwing example is a valid json file for downloading one tile:
83 #{
84 #"type": "FeatureCollection",
85 #"crs": { "type": "name", "properties": { "name": "urn:ogc:def:crs:OGC:1.3:CRS84" } },
86 #"features": [
87 #{ "type": "Feature", "properties": { }, "geometry": { "type": "Point", "coordinates": [ 9.802151766690342, 46.597270607460956 ] } }
88 #]
89 #}
90 #
91 # product_type
92 # ------------
93 # Possible value are:
94 # - S2MSI1C for Level 1C data
95 # - S2MSI2A for Level 2A data
96 #
97 # Complete example
98 # ----------------
99 #
100 # [che]
101 # clouds_min = 0
102 # clouds_max = 100
103 # date_start = 2016-12-01
104 # date_end = today
105 # footprint = che.geojson
106 # product_type = S2MSI1C