<!DOCTYPE html>
<html class="writer-html5" lang="en">
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>harpconvert — HARP 1.25 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="_static/css/theme.css" />
<link rel="stylesheet" type="text/css" href="_static/custom.css" />
<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script src="_static/jquery.js"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/sphinx_highlight.js"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="next" title="harpdump" href="harpdump.html" />
<link rel="prev" title="harpcollocate" href="harpcollocate.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">
HARP
</a>
<div class="version">
1.25
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="install.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="conventions/index.html">Conventions</a></li>
<li class="toctree-l1"><a class="reference internal" href="algorithms/index.html">Algorithms</a></li>
<li class="toctree-l1"><a class="reference internal" href="operations.html">Operations</a></li>
<li class="toctree-l1"><a class="reference internal" href="ingestions/index.html">Ingestion definitions</a></li>
<li class="toctree-l1"><a class="reference internal" href="libharp.html">C library</a></li>
<li class="toctree-l1"><a class="reference internal" href="idl.html">IDL interface</a></li>
<li class="toctree-l1"><a class="reference internal" href="matlab.html">MATLAB interface</a></li>
<li class="toctree-l1"><a class="reference internal" href="python.html">Python interface</a></li>
<li class="toctree-l1"><a class="reference internal" href="R.html">R interface</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="tools.html">Command line tools</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="harpcheck.html">harpcheck</a></li>
<li class="toctree-l2"><a class="reference internal" href="harpcollocate.html">harpcollocate</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">harpconvert</a></li>
<li class="toctree-l2"><a class="reference internal" href="harpdump.html">harpdump</a></li>
<li class="toctree-l2"><a class="reference internal" href="harpmerge.html">harpmerge</a></li>
</ul>
</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">HARP</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="tools.html">Command line tools</a></li>
<li class="breadcrumb-item active">harpconvert</li>
<li class="wy-breadcrumbs-aside">
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<section id="harpconvert">
<h1>harpconvert</h1>
<p>Convert a product from its original format to a HARP compliant netCDF/HDF4/HDF5
file that can be processed further with other HARP command line tools. See the
section <a class="reference internal" href="ingestions/index.html"><span class="doc">Ingestion definitions</span></a> for an overview of the
product types supported by HARP.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">Usage</span><span class="p">:</span>
<span class="n">harpconvert</span> <span class="p">[</span><span class="n">options</span><span class="p">]</span> <span class="o"><</span><span class="nb">input</span> <span class="n">product</span> <span class="n">file</span><span class="o">></span> <span class="o"><</span><span class="n">output</span> <span class="n">product</span> <span class="n">file</span><span class="o">></span>
<span class="n">Import</span> <span class="n">a</span> <span class="n">product</span> <span class="n">that</span> <span class="ow">is</span> <span class="n">stored</span> <span class="ow">in</span> <span class="n">HARP</span> <span class="nb">format</span> <span class="ow">or</span> <span class="ow">in</span> <span class="n">one</span> <span class="n">of</span> <span class="n">the</span>
<span class="n">supported</span> <span class="n">external</span> <span class="n">formats</span><span class="p">,</span> <span class="n">perform</span> <span class="n">operations</span> <span class="n">on</span> <span class="n">it</span> <span class="p">(</span><span class="k">if</span> <span class="n">provided</span><span class="p">),</span>
<span class="ow">and</span> <span class="n">save</span> <span class="n">the</span> <span class="n">results</span> <span class="n">to</span> <span class="n">a</span> <span class="n">HARP</span> <span class="n">netCDF</span><span class="o">/</span><span class="n">HDF4</span><span class="o">/</span><span class="n">HDF5</span> <span class="n">product</span><span class="o">.</span>
<span class="n">Options</span><span class="p">:</span>
<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>
<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">product</span><span class="o">.</span>
<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>
<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>
<span class="n">more</span> <span class="n">details</span><span class="o">.</span>
<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>
<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>
<span class="n">Only</span> <span class="n">applicable</span> <span class="k">if</span> <span class="n">the</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>
<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>
<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>
<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>
<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>
<span class="n">Output</span> <span class="nb">format</span><span class="p">:</span>
<span class="n">netcdf</span> <span class="p">(</span><span class="n">default</span><span class="p">)</span>
<span class="n">hdf4</span>
<span class="n">hdf5</span>
<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>
<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>
<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>
<span class="o">--</span><span class="n">no</span><span class="o">-</span><span class="n">history</span>
<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>
<span class="n">If</span> <span class="n">the</span> <span class="n">ingested</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>
<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>
<span class="n">harpconvert</span> <span class="o">--</span><span class="n">generate</span><span class="o">-</span><span class="n">documentation</span> <span class="p">[</span><span class="n">options</span><span class="p">]</span> <span class="p">[</span><span class="n">output</span> <span class="n">directory</span><span class="p">]</span>
<span class="n">Generate</span> <span class="n">a</span> <span class="n">series</span> <span class="n">of</span> <span class="n">documentation</span> <span class="n">files</span> <span class="ow">in</span> <span class="n">the</span> <span class="n">specified</span> <span class="n">output</span>
<span class="n">directory</span><span class="o">.</span> <span class="n">The</span> <span class="n">documentation</span> <span class="n">describes</span> <span class="n">the</span> <span class="nb">set</span> <span class="n">of</span> <span class="n">supported</span> <span class="n">foreign</span>
<span class="n">product</span> <span class="n">types</span> <span class="ow">and</span> <span class="n">the</span> <span class="n">details</span> <span class="n">of</span> <span class="n">the</span> <span class="n">HARP</span> <span class="n">product</span><span class="p">(</span><span class="n">s</span><span class="p">)</span> <span class="n">that</span> <span class="n">are</span>
<span class="n">produced</span> <span class="n">by</span> <span class="n">an</span> <span class="n">ingestion</span><span class="o">.</span>
<span class="n">harpconvert</span> <span class="o">-</span><span class="n">h</span><span class="p">,</span> <span class="o">--</span><span class="n">help</span>
<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>
<span class="n">harpconvert</span> <span class="o">-</span><span class="n">v</span><span class="p">,</span> <span class="o">--</span><span class="n">version</span>
<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>
</pre></div>
</div>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="harpcollocate.html" class="btn btn-neutral float-left" title="harpcollocate" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="harpdump.html" class="btn btn-neutral float-right" title="harpdump" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>© Copyright 2015-2025 S[&]T, The Netherlands.</p>
</div>
</footer>
</div>
</div>
</section>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>