Update documentation

metno · Jan 15, 2024 · e85da5e · e85da5e
1 parent 0f9364a
commit e85da5e
Show file tree

Hide file tree

Showing 6 changed files with 33 additions and 2 deletions.
diff --git a/_modules/pysurfex/cli.html b/_modules/pysurfex/cli.html
@@ -203,6 +203,13 @@ <h1>Source code for pysurfex.cli</h1><div class="highlight"><pre>
                 <span class="n">fileformat</span> <span class="o">=</span> <span class="n">kwargs</span><span class="p">[</span><span class="s2">&quot;sd_format&quot;</span><span class="p">]</span>
             <span class="k">if</span> <span class="s2">&quot;sd_converter&quot;</span> <span class="ow">in</span> <span class="n">kwargs</span> <span class="ow">and</span> <span class="n">kwargs</span><span class="p">[</span><span class="s2">&quot;sd_converter&quot;</span><span class="p">]</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
                 <span class="n">converter</span> <span class="o">=</span> <span class="n">kwargs</span><span class="p">[</span><span class="s2">&quot;sd_converter&quot;</span><span class="p">]</span>
+        <span class="k">elif</span> <span class="n">var</span> <span class="o">==</span> <span class="s2">&quot;sea_ice_thickness&quot;</span><span class="p">:</span>
+            <span class="k">if</span> <span class="s2">&quot;icetk_file&quot;</span> <span class="ow">in</span> <span class="n">kwargs</span> <span class="ow">and</span> <span class="n">kwargs</span><span class="p">[</span><span class="s2">&quot;icetk_file&quot;</span><span class="p">]</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
+                <span class="n">inputfile</span> <span class="o">=</span> <span class="n">kwargs</span><span class="p">[</span><span class="s2">&quot;icetk_file&quot;</span><span class="p">]</span>
+            <span class="k">if</span> <span class="s2">&quot;icetk_format&quot;</span> <span class="ow">in</span> <span class="n">kwargs</span> <span class="ow">and</span> <span class="n">kwargs</span><span class="p">[</span><span class="s2">&quot;icetk_format&quot;</span><span class="p">]</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
+                <span class="n">fileformat</span> <span class="o">=</span> <span class="n">kwargs</span><span class="p">[</span><span class="s2">&quot;icetk_format&quot;</span><span class="p">]</span>
+            <span class="k">if</span> <span class="s2">&quot;icetk_converter&quot;</span> <span class="ow">in</span> <span class="n">kwargs</span> <span class="ow">and</span> <span class="n">kwargs</span><span class="p">[</span><span class="s2">&quot;icetk_converter&quot;</span><span class="p">]</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
+                <span class="n">converter</span> <span class="o">=</span> <span class="n">kwargs</span><span class="p">[</span><span class="s2">&quot;icetk_converter&quot;</span><span class="p">]</span>
         <span class="k">elif</span> <span class="n">var</span> <span class="o">==</span> <span class="s2">&quot;cloud_base&quot;</span><span class="p">:</span>
             <span class="k">if</span> <span class="s2">&quot;cb_file&quot;</span> <span class="ow">in</span> <span class="n">kwargs</span> <span class="ow">and</span> <span class="n">kwargs</span><span class="p">[</span><span class="s2">&quot;cb_file&quot;</span><span class="p">]</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
                 <span class="n">inputfile</span> <span class="o">=</span> <span class="n">kwargs</span><span class="p">[</span><span class="s2">&quot;cb_file&quot;</span><span class="p">]</span>

diff --git a/_modules/pysurfex/cmd_parsing.html b/_modules/pysurfex/cmd_parsing.html
@@ -654,6 +654,25 @@ <h1>Source code for pysurfex.cmd_parsing</h1><div class="highlight"><pre>
         <span class="n">choices</span><span class="o">=</span><span class="p">[</span><span class="s2">&quot;none&quot;</span><span class="p">,</span> <span class="s2">&quot;sweclim&quot;</span><span class="p">,</span> <span class="s2">&quot;swe2sd&quot;</span><span class="p">,</span> <span class="s2">&quot;sdp&quot;</span><span class="p">],</span>
     <span class="p">)</span>
 
+    <span class="n">parser</span><span class="o">.</span><span class="n">add_argument</span><span class="p">(</span>
+        <span class="s2">&quot;-icetk_file&quot;</span><span class="p">,</span> <span class="nb">type</span><span class="o">=</span><span class="nb">str</span><span class="p">,</span> <span class="n">default</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">help</span><span class="o">=</span><span class="s2">&quot;Ice thickness file&quot;</span><span class="p">,</span> <span class="n">nargs</span><span class="o">=</span><span class="s2">&quot;?&quot;</span>
+    <span class="p">)</span>
+    <span class="n">parser</span><span class="o">.</span><span class="n">add_argument</span><span class="p">(</span>
+        <span class="s2">&quot;-icetk_format&quot;</span><span class="p">,</span>
+        <span class="nb">type</span><span class="o">=</span><span class="nb">str</span><span class="p">,</span>
+        <span class="n">default</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
+        <span class="n">help</span><span class="o">=</span><span class="s2">&quot;Ice thickness file format&quot;</span><span class="p">,</span>
+        <span class="n">nargs</span><span class="o">=</span><span class="s2">&quot;?&quot;</span><span class="p">,</span>
+        <span class="n">choices</span><span class="o">=</span><span class="p">[</span><span class="s2">&quot;grib1&quot;</span><span class="p">,</span> <span class="s2">&quot;grib2&quot;</span><span class="p">,</span> <span class="s2">&quot;netcdf&quot;</span><span class="p">,</span> <span class="s2">&quot;surfex&quot;</span><span class="p">,</span> <span class="s2">&quot;fa&quot;</span><span class="p">],</span>
+    <span class="p">)</span>
+    <span class="n">parser</span><span class="o">.</span><span class="n">add_argument</span><span class="p">(</span>
+        <span class="s2">&quot;--icetk_converter&quot;</span><span class="p">,</span>
+        <span class="nb">type</span><span class="o">=</span><span class="nb">str</span><span class="p">,</span>
+        <span class="n">default</span><span class="o">=</span><span class="s2">&quot;none&quot;</span><span class="p">,</span>
+        <span class="n">help</span><span class="o">=</span><span class="s2">&quot;&quot;</span><span class="p">,</span>
+        <span class="n">nargs</span><span class="o">=</span><span class="s2">&quot;?&quot;</span><span class="p">,</span>
+    <span class="p">)</span>
+
     <span class="n">parser</span><span class="o">.</span><span class="n">add_argument</span><span class="p">(</span>
         <span class="s2">&quot;-cb_file&quot;</span><span class="p">,</span> <span class="nb">type</span><span class="o">=</span><span class="nb">str</span><span class="p">,</span> <span class="n">default</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">help</span><span class="o">=</span><span class="s2">&quot;Cloud base file&quot;</span><span class="p">,</span> <span class="n">nargs</span><span class="o">=</span><span class="s2">&quot;?&quot;</span>
     <span class="p">)</span>
@@ -757,6 +776,7 @@ <h1>Source code for pysurfex.cmd_parsing</h1><div class="highlight"><pre>
             <span class="s2">&quot;air_temperature_2m&quot;</span><span class="p">,</span>
             <span class="s2">&quot;relative_humidity_2m&quot;</span><span class="p">,</span>
             <span class="s2">&quot;surface_snow_thickness&quot;</span><span class="p">,</span>
+            <span class="s2">&quot;sea_ice_thickness&quot;</span><span class="p">,</span>
             <span class="s2">&quot;cloud_base&quot;</span><span class="p">,</span>
             <span class="s2">&quot;surface_soil_moisture&quot;</span><span class="p">,</span>
         <span class="p">],</span>

diff --git a/_modules/pysurfex/netcdf.html b/_modules/pysurfex/netcdf.html
@@ -679,6 +679,7 @@ <h1>Source code for pysurfex.netcdf</h1><div class="highlight"><pre>
         <span class="s2">&quot;relative_humidity_2m&quot;</span><span class="p">:</span> <span class="s2">&quot;relative_humidity&quot;</span><span class="p">,</span>
         <span class="s2">&quot;altitude&quot;</span><span class="p">:</span> <span class="s2">&quot;altitude&quot;</span><span class="p">,</span>
         <span class="s2">&quot;surface_snow_thickness&quot;</span><span class="p">:</span> <span class="s2">&quot;surface_snow_thickness&quot;</span><span class="p">,</span>
+        <span class="s2">&quot;sea_ice_thickness&quot;</span><span class="p">:</span> <span class="s2">&quot;sea_ice_thickness&quot;</span><span class="p">,</span>
         <span class="s2">&quot;surface_soil_moisture&quot;</span><span class="p">:</span> <span class="s2">&quot;surface_soil_moisture&quot;</span><span class="p">,</span>
         <span class="s2">&quot;cloud_base&quot;</span><span class="p">:</span> <span class="s2">&quot;cloud_base&quot;</span><span class="p">,</span>
         <span class="s2">&quot;land_area_fraction&quot;</span><span class="p">:</span> <span class="s2">&quot;land_area_fraction&quot;</span><span class="p">,</span>
@@ -688,6 +689,7 @@ <h1>Source code for pysurfex.netcdf</h1><div class="highlight"><pre>
         <span class="s2">&quot;relative_humidity_2m&quot;</span><span class="p">:</span> <span class="s2">&quot;Screen level relative humidity (RH2M)&quot;</span><span class="p">,</span>
         <span class="s2">&quot;altitude&quot;</span><span class="p">:</span> <span class="s2">&quot;Altitude&quot;</span><span class="p">,</span>
         <span class="s2">&quot;surface_snow_thickness&quot;</span><span class="p">:</span> <span class="s2">&quot;Surface snow thickness&quot;</span><span class="p">,</span>
+        <span class="s2">&quot;sea_ice_thickness&quot;</span><span class="p">:</span> <span class="s2">&quot;Sea ice thickness&quot;</span><span class="p">,</span>
         <span class="s2">&quot;surface_soil_moisture&quot;</span><span class="p">:</span> <span class="s2">&quot;Surface soil moisture&quot;</span><span class="p">,</span>
         <span class="s2">&quot;cloud_base&quot;</span><span class="p">:</span> <span class="s2">&quot;Cloud base&quot;</span><span class="p">,</span>
         <span class="s2">&quot;land_area_fraction&quot;</span><span class="p">:</span> <span class="s2">&quot;Land Area Fraction&quot;</span><span class="p">,</span>
@@ -697,6 +699,7 @@ <h1>Source code for pysurfex.netcdf</h1><div class="highlight"><pre>
         <span class="s2">&quot;relative_humidity_2m&quot;</span><span class="p">:</span> <span class="s2">&quot;1&quot;</span><span class="p">,</span>
         <span class="s2">&quot;altitude&quot;</span><span class="p">:</span> <span class="s2">&quot;m&quot;</span><span class="p">,</span>
         <span class="s2">&quot;surface_snow_thickness&quot;</span><span class="p">:</span> <span class="s2">&quot;m&quot;</span><span class="p">,</span>
+        <span class="s2">&quot;sea_ice_thickness&quot;</span><span class="p">:</span> <span class="s2">&quot;m&quot;</span><span class="p">,</span>
         <span class="s2">&quot;surface_soil_moisture&quot;</span><span class="p">:</span> <span class="s2">&quot;m3/m3&quot;</span><span class="p">,</span>
         <span class="s2">&quot;cloud_base&quot;</span><span class="p">:</span> <span class="s2">&quot;m&quot;</span><span class="p">,</span>
         <span class="s2">&quot;land_area_fraction&quot;</span><span class="p">:</span> <span class="s2">&quot;1&quot;</span><span class="p">,</span>
@@ -706,6 +709,7 @@ <h1>Source code for pysurfex.netcdf</h1><div class="highlight"><pre>
         <span class="s2">&quot;relative_humidity_2m&quot;</span><span class="p">:</span> <span class="s2">&quot;9.96921e+36&quot;</span><span class="p">,</span>
         <span class="s2">&quot;altitude&quot;</span><span class="p">:</span> <span class="s2">&quot;9.96921e+36&quot;</span><span class="p">,</span>
         <span class="s2">&quot;surface_snow_thickness&quot;</span><span class="p">:</span> <span class="s2">&quot;9.96921e+36&quot;</span><span class="p">,</span>
+        <span class="s2">&quot;sea_ice_thickness&quot;</span><span class="p">:</span> <span class="s2">&quot;9.96921e+36&quot;</span><span class="p">,</span>
         <span class="s2">&quot;surface_soil_moisture&quot;</span><span class="p">:</span> <span class="s2">&quot;9.96921e+36&quot;</span><span class="p">,</span>
         <span class="s2">&quot;cloud_base&quot;</span><span class="p">:</span> <span class="s2">&quot;9.96921e+36&quot;</span><span class="p">,</span>
         <span class="s2">&quot;land_area_fraction&quot;</span><span class="p">:</span> <span class="s2">&quot;9.96921e+36&quot;</span><span class="p">,</span>

diff --git a/_sources/index.rst.txt b/_sources/index.rst.txt
@@ -1,5 +1,5 @@
 .. SURFEX Python API documentation master file, created by
-   auto_sphinx.py on Wed Dec 20 08:51:35 2023
+   auto_sphinx.py on Mon Jan 15 15:14:19 2024
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 

diff --git a/objects.inv b/objects.inv
diff --git a/searchindex.js b/searchindex.js