| 1 |
<!DOCTYPE html> |
| 2 |
<html class="writer-html5" lang="en"> |
| 3 |
<head> |
| 4 |
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" /> |
| 5 |
|
| 6 |
<meta name="viewport" content="width=device-width, initial-scale=1.0" /> |
| 7 |
<title>harpmerge — HARP 1.29 documentation</title> |
| 8 |
<link rel="stylesheet" type="text/css" href="_static/pygments.css" /> |
| 9 |
<link rel="stylesheet" type="text/css" href="_static/css/theme.css" /> |
| 10 |
<link rel="stylesheet" type="text/css" href="_static/custom.css" /> |
| 11 |
|
| 12 |
|
| 13 |
<!--[if lt IE 9]> |
| 14 |
<script src="_static/js/html5shiv.min.js"></script> |
| 15 |
<![endif]--> |
| 16 |
|
| 17 |
<script src="_static/jquery.js"></script> |
| 18 |
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script> |
| 19 |
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script> |
| 20 |
<script src="_static/doctools.js"></script> |
| 21 |
<script src="_static/sphinx_highlight.js"></script> |
| 22 |
<script src="_static/js/theme.js"></script> |
| 23 |
<link rel="index" title="Index" href="genindex.html" /> |
| 24 |
<link rel="prev" title="harpdump" href="harpdump.html" /> |
| 25 |
</head> |
| 26 |
|
| 27 |
<body class="wy-body-for-nav"> |
| 28 |
<div class="wy-grid-for-nav"> |
| 29 |
<nav data-toggle="wy-nav-shift" class="wy-nav-side"> |
| 30 |
<div class="wy-side-scroll"> |
| 31 |
<div class="wy-side-nav-search" > |
| 32 |
|
| 33 |
|
| 34 |
|
| 35 |
<a href="index.html" class="icon icon-home"> |
| 36 |
HARP |
| 37 |
</a> |
| 38 |
<div class="version"> |
| 39 |
1.29 |
| 40 |
</div> |
| 41 |
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu"> |
| 42 |
<ul class="current"> |
| 43 |
<li class="toctree-l1"><a class="reference internal" href="install.html">Installation</a></li> |
| 44 |
<li class="toctree-l1"><a class="reference internal" href="conventions/index.html">Conventions</a></li> |
| 45 |
<li class="toctree-l1"><a class="reference internal" href="algorithms/index.html">Algorithms</a></li> |
| 46 |
<li class="toctree-l1"><a class="reference internal" href="operations.html">Operations</a></li> |
| 47 |
<li class="toctree-l1"><a class="reference internal" href="ingestions/index.html">Ingestion definitions</a></li> |
| 48 |
<li class="toctree-l1"><a class="reference internal" href="libharp.html">C library</a></li> |
| 49 |
<li class="toctree-l1"><a class="reference internal" href="idl.html">IDL interface</a></li> |
| 50 |
<li class="toctree-l1"><a class="reference internal" href="matlab.html">MATLAB interface</a></li> |
| 51 |
<li class="toctree-l1"><a class="reference internal" href="python.html">Python interface</a></li> |
| 52 |
<li class="toctree-l1"><a class="reference internal" href="R.html">R interface</a></li> |
| 53 |
<li class="toctree-l1 current"><a class="reference internal" href="tools.html">Command line tools</a><ul class="current"> |
| 54 |
<li class="toctree-l2"><a class="reference internal" href="harpcheck.html">harpcheck</a></li> |
| 55 |
<li class="toctree-l2"><a class="reference internal" href="harpcollocate.html">harpcollocate</a></li> |
| 56 |
<li class="toctree-l2"><a class="reference internal" href="harpconvert.html">harpconvert</a></li> |
| 57 |
<li class="toctree-l2"><a class="reference internal" href="harpdump.html">harpdump</a></li> |
| 58 |
<li class="toctree-l2 current"><a class="current reference internal" href="#">harpmerge</a></li> |
| 59 |
</ul> |
| 60 |
</li> |
| 61 |
</ul> |
| 62 |
|
| 63 |
</div> |
| 64 |
</div> |
| 65 |
</nav> |
| 66 |
|
| 67 |
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" > |
| 68 |
<i data-toggle="wy-nav-top" class="fa fa-bars"></i> |
| 69 |
<a href="index.html">HARP</a> |
| 70 |
</nav> |
| 71 |
|
| 72 |
<div class="wy-nav-content"> |
| 73 |
<div class="rst-content"> |
| 74 |
<div role="navigation" aria-label="Page navigation"> |
| 75 |
<ul class="wy-breadcrumbs"> |
| 76 |
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li> |
| 77 |
<li class="breadcrumb-item"><a href="tools.html">Command line tools</a></li> |
| 78 |
<li class="breadcrumb-item active">harpmerge</li> |
| 79 |
<li class="wy-breadcrumbs-aside"> |
| 80 |
</li> |
| 81 |
</ul> |
| 82 |
<hr/> |
| 83 |
</div> |
| 84 |
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> |
| 85 |
<div itemprop="articleBody"> |
| 86 |
|
| 87 |
<section id="harpmerge"> |
| 88 |
<h1>harpmerge</h1> |
| 89 |
<p>Combine multiple products from files or directories by appending them across |
| 90 |
the time dimension and storing the result into a single output file.</p> |
| 91 |
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">Usage</span><span class="p">:</span> |
| 92 |
<span class="n">harpmerge</span> <span class="p">[</span><span class="n">options</span><span class="p">]</span> <span class="o"><</span><span class="n">file</span><span class="o">|</span><span class="nb">dir</span><span class="o">></span> <span class="p">[</span><span class="o"><</span><span class="n">file</span><span class="o">|</span><span class="nb">dir</span><span class="o">></span> <span class="o">...</span><span class="p">]</span> <span class="o"><</span><span class="n">output</span> <span class="n">product</span> <span class="n">file</span><span class="o">></span> |
| 93 |
<span class="n">Concatenate</span> <span class="nb">all</span> <span class="n">products</span> <span class="k">as</span> <span class="n">specified</span> <span class="n">by</span> <span class="n">the</span> <span class="n">file</span> <span class="ow">and</span> <span class="n">directory</span> <span class="n">paths</span> |
| 94 |
<span class="n">into</span> <span class="n">a</span> <span class="n">single</span> <span class="n">product</span><span class="o">.</span> |
| 95 |
<span class="n">If</span> <span class="n">a</span> <span class="n">directory</span> <span class="ow">is</span> <span class="n">specified</span> <span class="n">then</span> <span class="nb">all</span> <span class="n">files</span> <span class="p">(</span><span class="n">recursively</span><span class="p">)</span> <span class="kn">from</span> <span class="nn">that</span> |
| 96 |
<span class="n">directory</span> <span class="n">are</span> <span class="n">included</span><span class="o">.</span> |
| 97 |
<span class="n">If</span> <span class="n">a</span> <span class="n">file</span> <span class="ow">is</span> <span class="n">a</span> <span class="o">.</span><span class="n">pth</span> <span class="n">file</span> <span class="n">then</span> <span class="n">the</span> <span class="n">file</span> <span class="n">paths</span> <span class="kn">from</span> <span class="nn">that</span> <span class="n">text</span> <span class="n">file</span> |
| 98 |
<span class="p">(</span><span class="n">one</span> <span class="n">per</span> <span class="n">line</span><span class="p">)</span> <span class="n">are</span> <span class="n">included</span><span class="o">.</span> <span class="n">These</span> <span class="n">file</span> <span class="n">paths</span> <span class="n">can</span> <span class="n">be</span> <span class="n">absolute</span> <span class="ow">or</span> |
| 99 |
<span class="n">relative</span> <span class="ow">and</span> <span class="n">can</span> <span class="n">point</span> <span class="n">to</span> <span class="n">files</span><span class="p">,</span> <span class="n">directories</span><span class="p">,</span> <span class="ow">or</span> <span class="n">other</span> <span class="o">.</span><span class="n">pth</span> <span class="n">files</span><span class="o">.</span> |
| 100 |
<span class="n">Note</span> <span class="n">that</span> <span class="n">the</span> <span class="s1">'source_product'</span> <span class="n">attribute</span> <span class="n">of</span> <span class="n">products</span> <span class="ow">in</span> <span class="n">a</span> <span class="o">.</span><span class="n">pth</span> <span class="n">file</span> |
| 101 |
<span class="n">needs</span> <span class="n">to</span> <span class="n">be</span> <span class="n">unique</span><span class="p">;</span> <span class="k">if</span> <span class="n">a</span> <span class="o">.</span><span class="n">pth</span> <span class="n">file</span> <span class="n">references</span> <span class="n">multiple</span> <span class="n">products</span> <span class="k">with</span> |
| 102 |
<span class="n">the</span> <span class="n">same</span> <span class="s1">'source_product'</span> <span class="n">value</span> <span class="n">then</span> <span class="n">only</span> <span class="n">the</span> <span class="n">last</span> <span class="n">product</span> <span class="ow">in</span> <span class="n">the</span> |
| 103 |
<span class="nb">list</span> <span class="n">will</span> <span class="n">be</span> <span class="n">kept</span><span class="o">.</span> |
| 104 |
|
| 105 |
<span class="n">Options</span><span class="p">:</span> |
| 106 |
<span class="o">-</span><span class="n">a</span><span class="p">,</span> <span class="o">--</span><span class="n">operations</span> <span class="o"><</span><span class="n">operation</span> <span class="nb">list</span><span class="o">></span> |
| 107 |
<span class="n">List</span> <span class="n">of</span> <span class="n">operations</span> <span class="n">to</span> <span class="n">apply</span> <span class="n">to</span> <span class="n">each</span> <span class="n">product</span><span class="o">.</span> |
| 108 |
<span class="n">An</span> <span class="n">operation</span> <span class="nb">list</span> <span class="n">needs</span> <span class="n">to</span> <span class="n">be</span> <span class="n">provided</span> <span class="k">as</span> <span class="n">a</span> <span class="n">single</span> <span class="n">expression</span><span class="o">.</span> |
| 109 |
<span class="n">See</span> <span class="n">the</span> <span class="s1">'operations'</span> <span class="n">section</span> <span class="n">of</span> <span class="n">the</span> <span class="n">HARP</span> <span class="n">documentation</span> <span class="k">for</span> |
| 110 |
<span class="n">more</span> <span class="n">details</span><span class="o">.</span> |
| 111 |
<span class="n">Operations</span> <span class="n">will</span> <span class="n">be</span> <span class="n">performed</span> <span class="n">before</span> <span class="n">a</span> <span class="n">product</span> <span class="ow">is</span> <span class="n">appended</span><span class="o">.</span> |
| 112 |
|
| 113 |
<span class="o">-</span><span class="n">ar</span><span class="p">,</span> <span class="o">--</span><span class="n">reduce</span><span class="o">-</span><span class="n">operations</span> <span class="o"><</span><span class="n">operation</span> <span class="nb">list</span><span class="o">></span> |
| 114 |
<span class="n">List</span> <span class="n">of</span> <span class="n">operations</span> <span class="n">to</span> <span class="n">apply</span> <span class="n">after</span> <span class="n">each</span> <span class="n">append</span><span class="o">.</span> |
| 115 |
<span class="n">This</span> <span class="n">advanced</span> <span class="n">option</span> <span class="n">allows</span> <span class="k">for</span> <span class="n">memory</span> <span class="n">efficient</span> <span class="n">application</span> |
| 116 |
<span class="n">of</span> <span class="n">time</span> <span class="n">reduction</span> <span class="n">operations</span> <span class="p">(</span><span class="n">such</span> <span class="k">as</span> <span class="nb">bin</span><span class="p">())</span> <span class="n">that</span> <span class="n">would</span> |
| 117 |
<span class="n">normally</span> <span class="n">be</span> <span class="n">provided</span> <span class="k">as</span> <span class="n">part</span> <span class="n">of</span> <span class="n">the</span> <span class="n">post</span> <span class="n">operations</span><span class="o">.</span> |
| 118 |
|
| 119 |
<span class="o">-</span><span class="n">ap</span><span class="p">,</span> <span class="o">--</span><span class="n">post</span><span class="o">-</span><span class="n">operations</span> <span class="o"><</span><span class="n">operation</span> <span class="nb">list</span><span class="o">></span> |
| 120 |
<span class="n">List</span> <span class="n">of</span> <span class="n">operations</span> <span class="n">to</span> <span class="n">apply</span> <span class="n">to</span> <span class="n">the</span> <span class="n">merged</span> <span class="n">product</span><span class="o">.</span> |
| 121 |
<span class="n">An</span> <span class="n">operation</span> <span class="nb">list</span> <span class="n">needs</span> <span class="n">to</span> <span class="n">be</span> <span class="n">provided</span> <span class="k">as</span> <span class="n">a</span> <span class="n">single</span> <span class="n">expression</span><span class="o">.</span> |
| 122 |
<span class="n">See</span> <span class="n">the</span> <span class="s1">'operations'</span> <span class="n">section</span> <span class="n">of</span> <span class="n">the</span> <span class="n">HARP</span> <span class="n">documentation</span> <span class="k">for</span> |
| 123 |
<span class="n">more</span> <span class="n">details</span><span class="o">.</span> |
| 124 |
|
| 125 |
<span class="o">-</span><span class="n">o</span><span class="p">,</span> <span class="o">--</span><span class="n">options</span> <span class="o"><</span><span class="n">option</span> <span class="nb">list</span><span class="o">></span> |
| 126 |
<span class="n">List</span> <span class="n">of</span> <span class="n">options</span> <span class="n">to</span> <span class="k">pass</span> <span class="n">to</span> <span class="n">the</span> <span class="n">ingestion</span> <span class="n">module</span><span class="o">.</span> |
| 127 |
<span class="n">Only</span> <span class="n">applicable</span> <span class="k">if</span> <span class="n">an</span> <span class="nb">input</span> <span class="n">product</span> <span class="ow">is</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">HARP</span> <span class="nb">format</span><span class="o">.</span> |
| 128 |
<span class="n">Options</span> <span class="n">are</span> <span class="n">separated</span> <span class="n">by</span> <span class="n">semi</span><span class="o">-</span><span class="n">colons</span><span class="o">.</span> <span class="n">Each</span> <span class="n">option</span> <span class="n">consists</span> |
| 129 |
<span class="n">of</span> <span class="n">an</span> <span class="o"><</span><span class="n">option</span> <span class="n">name</span><span class="o">>=<</span><span class="n">value</span><span class="o">></span> <span class="n">pair</span><span class="o">.</span> <span class="n">An</span> <span class="n">option</span> <span class="nb">list</span> <span class="n">needs</span> <span class="n">to</span> <span class="n">be</span> |
| 130 |
<span class="n">provided</span> <span class="k">as</span> <span class="n">a</span> <span class="n">single</span> <span class="n">expression</span><span class="o">.</span> |
| 131 |
|
| 132 |
<span class="o">-</span><span class="n">l</span><span class="p">,</span> <span class="o">--</span><span class="nb">list</span> |
| 133 |
<span class="n">Print</span> <span class="n">to</span> <span class="n">stdout</span> <span class="n">each</span> <span class="n">filename</span> <span class="n">that</span> <span class="ow">is</span> <span class="n">currently</span> <span class="n">being</span> <span class="n">merged</span><span class="o">.</span> |
| 134 |
|
| 135 |
<span class="o">-</span><span class="n">f</span><span class="p">,</span> <span class="o">--</span><span class="nb">format</span> <span class="o"><</span><span class="nb">format</span><span class="o">></span> |
| 136 |
<span class="n">Output</span> <span class="nb">format</span><span class="p">:</span> |
| 137 |
<span class="n">netcdf</span> <span class="p">(</span><span class="n">default</span><span class="p">)</span> |
| 138 |
<span class="n">hdf4</span> |
| 139 |
<span class="n">hdf5</span> |
| 140 |
|
| 141 |
<span class="o">--</span><span class="n">hdf5</span><span class="o">-</span><span class="n">compression</span> <span class="o"><</span><span class="n">level</span><span class="o">></span> |
| 142 |
<span class="n">Set</span> <span class="n">data</span> <span class="n">compression</span> <span class="n">level</span> <span class="k">for</span> <span class="n">storing</span> <span class="ow">in</span> <span class="n">HDF5</span> <span class="nb">format</span><span class="o">.</span> |
| 143 |
<span class="mi">0</span><span class="o">=</span><span class="n">disabled</span><span class="p">,</span> <span class="mi">1</span><span class="o">=</span><span class="n">low</span><span class="p">,</span> <span class="o">...</span><span class="p">,</span> <span class="mi">9</span><span class="o">=</span><span class="n">high</span><span class="o">.</span> |
| 144 |
|
| 145 |
<span class="o">--</span><span class="n">no</span><span class="o">-</span><span class="n">history</span> |
| 146 |
<span class="n">Do</span> <span class="ow">not</span> <span class="n">update</span> <span class="n">the</span> <span class="k">global</span> <span class="n">history</span> <span class="n">attribute</span><span class="o">.</span> |
| 147 |
|
| 148 |
<span class="n">If</span> <span class="n">the</span> <span class="n">merged</span> <span class="n">product</span> <span class="ow">is</span> <span class="n">empty</span><span class="p">,</span> <span class="n">a</span> <span class="n">warning</span> <span class="n">will</span> <span class="n">be</span> <span class="n">printed</span> <span class="ow">and</span> <span class="n">the</span> |
| 149 |
<span class="n">tool</span> <span class="n">will</span> <span class="k">return</span> <span class="k">with</span> <span class="n">exit</span> <span class="n">code</span> <span class="mi">2</span> <span class="p">(</span><span class="n">without</span> <span class="n">writing</span> <span class="n">a</span> <span class="n">file</span><span class="p">)</span><span class="o">.</span> |
| 150 |
|
| 151 |
<span class="n">harpmerge</span> <span class="o">-</span><span class="n">h</span><span class="p">,</span> <span class="o">--</span><span class="n">help</span> |
| 152 |
<span class="n">Show</span> <span class="n">help</span> <span class="p">(</span><span class="n">this</span> <span class="n">text</span><span class="p">)</span><span class="o">.</span> |
| 153 |
|
| 154 |
<span class="n">harpmerge</span> <span class="o">-</span><span class="n">v</span><span class="p">,</span> <span class="o">--</span><span class="n">version</span> |
| 155 |
<span class="n">Print</span> <span class="n">the</span> <span class="n">version</span> <span class="n">number</span> <span class="n">of</span> <span class="n">HARP</span> <span class="ow">and</span> <span class="n">exit</span><span class="o">.</span> |
| 156 |
</pre></div> |
| 157 |
</div> |
| 158 |
</section> |
| 159 |
|
| 160 |
|
| 161 |
</div> |
| 162 |
</div> |
| 163 |
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer"> |
| 164 |
<a href="harpdump.html" class="btn btn-neutral float-left" title="harpdump" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> |
| 165 |
</div> |
| 166 |
|
| 167 |
<hr/> |
| 168 |
|
| 169 |
<div role="contentinfo"> |
| 170 |
<p>© Copyright 2015-2026 S[&]T, The Netherlands.</p> |
| 171 |
</div> |
| 172 |
|
| 173 |
|
| 174 |
|
| 175 |
</footer> |
| 176 |
</div> |
| 177 |
</div> |
| 178 |
</section> |
| 179 |
</div> |
| 180 |
<script> |
| 181 |
jQuery(function () { |
| 182 |
SphinxRtdTheme.Navigation.enable(true); |
| 183 |
}); |
| 184 |
</script> |
| 185 |
|
| 186 |
</body> |
| 187 |
</html> |