Newer
Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Eodag configuration file — modspa-pixel 0.1 documentation</title>
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../_static/graphviz.css" type="text/css" />
<link rel="stylesheet" href="../_static/custom.css" type="text/css" />
<!--[if lt IE 9]>
<script src="../_static/js/html5shiv.min.js"></script>
<![endif]-->
<script src="../_static/jquery.js?v=5d32c60e"></script>
<script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="../_static/documentation_options.js?v=2709fde1"></script>
<script src="../_static/doctools.js?v=888ff710"></script>
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="../_static/js/theme.js"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="Choosing the run mode" href="../mode/mode.html" />
<link rel="prev" title="Understanding the json config file" href="json_config_file.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="../index.html" class="icon icon-home">
modspa-pixel
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="setup.html">Setting up the correct environnment and parameters</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="conda_env.html">Installing the conda environment</a></li>
<li class="toctree-l2"><a class="reference internal" href="json_config_file.html">Understanding the json config file</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">Eodag configuration file</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../mode/mode.html">Choosing the run mode</a></li>
<li class="toctree-l1"><a class="reference internal" href="../preprocessing/input_preparation.html">Preparing the inputs for Modspa-Pixel</a></li>
<li class="toctree-l1"><a class="reference internal" href="../samir/run_samir.html">Run the SAMIR model</a></li>
<li class="toctree-l1"><a class="reference internal" href="../file_structure.html">Project file structure</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../index.html">modspa-pixel</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="../index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item"><a href="setup.html">Setting up the correct environnment and parameters</a></li>
<li class="breadcrumb-item active">Eodag configuration file</li>
<li class="wy-breadcrumbs-aside">
<a href="../_sources/setup/eodag_config.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<section id="eodag-configuration-file">
<span id="eodag-config"></span><h1>Eodag configuration file<a class="headerlink" href="#eodag-configuration-file" title="Link to this heading"></a></h1>
<p><strong>Eodag</strong> is the module used to automatically download Sentinel-2 imagery. It uses a <code class="docutils literal notranslate"><span class="pre">yaml</span></code> configuration file that is created when <strong>eodag</strong> is first called. After that first call you can find it <code class="code docutils literal notranslate"><span class="pre">/home/user/.config/eodag/eodag.yml</span></code> (this path should be added in the <a class="reference internal" href="json_config_file.html#json-config"><span class="std std-ref">json config file</span></a>). This module is only used for the <strong>scihub</strong> and <strong>theia</strong> providers (usually <em>scihub</em> which covers most of the world), so you can focus on those two providers.</p>
<p>The <code class="docutils literal notranslate"><span class="pre">yaml</span></code> configuration file has data for a whole range of providers, you can find more information on how to create accounts for <a class="reference external" href="https://eodag.readthedocs.io/en/stable/getting_started_guide/register.html">eodag providers</a>. The four important parameters to set are the following: <code class="docutils literal notranslate"><span class="pre">extract</span></code>, <code class="docutils literal notranslate"><span class="pre">outputs_prefix</span></code>, <code class="docutils literal notranslate"><span class="pre">username</span></code> and <code class="docutils literal notranslate"><span class="pre">password</span></code>:</p>
<ul class="simple">
<li><p>The <code class="docutils literal notranslate"><span class="pre">extract</span></code> should be set to false, this means <strong>eodag</strong> will not extract the downloaded archives (the input preparation scripts later extract only the relevant bands).</p></li>
<li><p>The <code class="docutils literal notranslate"><span class="pre">outputs_prefix</span></code> corresponds to the download_path defined in the <a class="reference internal" href="json_config_file.html#json-config"><span class="std std-ref">json config file</span></a> with the provider sub-directory, this is where the Sentinel-2 data will be downloaded (and where the NDVI data will be written in a sub-directory later on). This directory should be automatically written by the input preparation scripts based on the information in the <a class="reference internal" href="json_config_file.html#json-config"><span class="std std-ref">json config file</span></a>.</p></li>
<li><p>The <code class="docutils literal notranslate"><span class="pre">username</span></code> and <code class="docutils literal notranslate"><span class="pre">password</span></code> are the ones you created to get access to Sentinel-2 data.</p></li>
</ul>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p>Putting some special characters like <code class="docutils literal notranslate"><span class="pre">!</span></code>, <code class="docutils literal notranslate"><span class="pre">$</span></code> or <code class="docutils literal notranslate"><span class="pre">#</span></code> at the begining of your password can cause reading issues with the <strong>eodag</strong> module.</p>
</div>
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="nt">scihub</span><span class="p">:</span>
<span class="w"> </span><span class="nt">priority</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">2</span><span class="w"> </span><span class="c1"># Must be higher than the other providers' priorities to download</span>
<span class="w"> </span><span class="nt">api</span><span class="p">:</span>
<span class="w"> </span><span class="nt">extract</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">false</span>
<span class="w"> </span><span class="nt">outputs_prefix</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/my/download/directory/SCIHUB/</span>
<span class="w"> </span><span class="nt">credentials</span><span class="p">:</span>
<span class="w"> </span><span class="nt">username</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">my_scihub_username</span>
<span class="w"> </span><span class="nt">password</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">my_scihub_password</span>
<span class="nt">theia</span><span class="p">:</span>
<span class="w"> </span><span class="nt">priority</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">0</span><span class="w"> </span><span class="c1"># Lower value means lower priority (Default: 0)</span>
<span class="w"> </span><span class="nt">search</span><span class="p">:</span>
<span class="w"> </span><span class="nt">download</span><span class="p">:</span>
<span class="w"> </span><span class="nt">extract</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">false</span>
<span class="w"> </span><span class="nt">outputs_prefix</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/my/download/directory/THEIA/</span>
<span class="w"> </span><span class="nt">dl_url_params</span><span class="p">:</span>
<span class="w"> </span><span class="nt">auth</span><span class="p">:</span>
<span class="w"> </span><span class="nt">credentials</span><span class="p">:</span>
<span class="w"> </span><span class="nt">ident</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">my_theia_username</span>
<span class="w"> </span><span class="nt">pass</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">my_theia_password</span>
</pre></div>
</div>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="json_config_file.html" class="btn btn-neutral float-left" title="Understanding the json config file" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="../mode/mode.html" class="btn btn-neutral float-right" title="Choosing the run mode" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>© Copyright 2023, auclairj.</p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>