Prepare new version

kartverket · Apr 26, 2021 · ebd355d · ebd355d
1 parent 0962b1b
commit ebd355d
Show file tree

Hide file tree

Showing 27 changed files with 156 additions and 61 deletions.
diff --git a/.bumpversion.cfg b/.bumpversion.cfg
@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 1.1.3
+current_version = 1.1.4
 commit = False
 tag = False
 

diff --git a/docs/404.html b/docs/404.html
@@ -8,7 +8,7 @@
 
 
         <link rel="shortcut icon" href="/img/favicon.ico">
-        <title>Midgard v1.1.3</title>
+        <title>Midgard v1.1.4</title>
         <link href="/css/bootstrap.min.css" rel="stylesheet">
         <link href="/css/font-awesome.min.css" rel="stylesheet">
         <link href="/css/base.css" rel="stylesheet">
@@ -23,7 +23,7 @@
     <body>
         <div class="navbar fixed-top navbar-expand-lg navbar-dark bg-primary">
             <div class="container">
-                <a class="navbar-brand" href="/.">Midgard v1.1.3</a>
+                <a class="navbar-brand" href="/.">Midgard v1.1.4</a>
                 <!-- Expander button -->
                 <button type="button" class="navbar-toggler" data-toggle="collapse" data-target="#navbar-collapse">
                     <span class="navbar-toggler-icon"></span>

diff --git a/docs/api/midgard-collections/index.html b/docs/api/midgard-collections/index.html
@@ -8,7 +8,7 @@
 
 
         <link rel="shortcut icon" href="../../img/favicon.ico">
-        <title>midgard.collections - Midgard v1.1.3</title>
+        <title>midgard.collections - Midgard v1.1.4</title>
         <link href="../../css/bootstrap.min.css" rel="stylesheet">
         <link href="../../css/font-awesome.min.css" rel="stylesheet">
         <link href="../../css/base.css" rel="stylesheet">
@@ -23,7 +23,7 @@
     <body>
         <div class="navbar fixed-top navbar-expand-lg navbar-dark bg-primary">
             <div class="container">
-                <a class="navbar-brand" href="../..">Midgard v1.1.3</a>
+                <a class="navbar-brand" href="../..">Midgard v1.1.4</a>
                 <!-- Expander button -->
                 <button type="button" class="navbar-toggler" data-toggle="collapse" data-target="#navbar-collapse">
                     <span class="navbar-toggler-icon"></span>

diff --git a/docs/api/midgard-config/index.html b/docs/api/midgard-config/index.html
@@ -8,7 +8,7 @@
 
 
         <link rel="shortcut icon" href="../../img/favicon.ico">
-        <title>midgard.config - Midgard v1.1.3</title>
+        <title>midgard.config - Midgard v1.1.4</title>
         <link href="../../css/bootstrap.min.css" rel="stylesheet">
         <link href="../../css/font-awesome.min.css" rel="stylesheet">
         <link href="../../css/base.css" rel="stylesheet">
@@ -23,7 +23,7 @@
     <body>
         <div class="navbar fixed-top navbar-expand-lg navbar-dark bg-primary">
             <div class="container">
-                <a class="navbar-brand" href="../..">Midgard v1.1.3</a>
+                <a class="navbar-brand" href="../..">Midgard v1.1.4</a>
                 <!-- Expander button -->
                 <button type="button" class="navbar-toggler" data-toggle="collapse" data-target="#navbar-collapse">
                     <span class="navbar-toggler-icon"></span>
@@ -200,7 +200,7 @@ <h2 id="midgardconfigconfig">midgard.config.config</h2>
 <p><strong>Help text and Type hints:</strong></p>
 <h3 id="casedconfigparser"><strong>CasedConfigParser</strong></h3>
 <p>Full name: <code>midgard.config.config.CasedConfigParser</code></p>
-<p>Signature: <code>(defaults=None, dict_type=&lt;class 'dict'&gt;, allow_no_value=False, *, delimiters=('=', ':'), comment_prefixes=('#', ';'), inline_comment_prefixes=None, strict=True, empty_lines_in_values=True, default_section='DEFAULT', interpolation=&lt;object object at 0x7fa99576b930&gt;, converters=&lt;object object at 0x7fa99576b930&gt;)</code></p>
+<p>Signature: <code>(defaults=None, dict_type=&lt;class 'dict'&gt;, allow_no_value=False, *, delimiters=('=', ':'), comment_prefixes=('#', ';'), inline_comment_prefixes=None, strict=True, empty_lines_in_values=True, default_section='DEFAULT', interpolation=&lt;object object at 0x7fde4ee5e930&gt;, converters=&lt;object object at 0x7fde4ee5e930&gt;)</code></p>
 <p>ConfigParser with case-sensitive keys</p>
 <h3 id="configuration"><strong>Configuration</strong></h3>
 <p>Full name: <code>midgard.config.config.Configuration</code></p>

diff --git a/docs/api/midgard-data/index.html b/docs/api/midgard-data/index.html
@@ -8,7 +8,7 @@
 
 
         <link rel="shortcut icon" href="../../img/favicon.ico">
-        <title>midgard.data - Midgard v1.1.3</title>
+        <title>midgard.data - Midgard v1.1.4</title>
         <link href="../../css/bootstrap.min.css" rel="stylesheet">
         <link href="../../css/font-awesome.min.css" rel="stylesheet">
         <link href="../../css/base.css" rel="stylesheet">
@@ -23,7 +23,7 @@
     <body>
         <div class="navbar fixed-top navbar-expand-lg navbar-dark bg-primary">
             <div class="container">
-                <a class="navbar-brand" href="../..">Midgard v1.1.3</a>
+                <a class="navbar-brand" href="../..">Midgard v1.1.4</a>
                 <!-- Expander button -->
                 <button type="button" class="navbar-toggler" data-toggle="collapse" data-target="#navbar-collapse">
                     <span class="navbar-toggler-icon"></span>

diff --git a/docs/api/midgard-dev/index.html b/docs/api/midgard-dev/index.html
@@ -8,7 +8,7 @@
 
 
         <link rel="shortcut icon" href="../../img/favicon.ico">
-        <title>midgard.dev - Midgard v1.1.3</title>
+        <title>midgard.dev - Midgard v1.1.4</title>
         <link href="../../css/bootstrap.min.css" rel="stylesheet">
         <link href="../../css/font-awesome.min.css" rel="stylesheet">
         <link href="../../css/base.css" rel="stylesheet">
@@ -23,7 +23,7 @@
     <body>
         <div class="navbar fixed-top navbar-expand-lg navbar-dark bg-primary">
             <div class="container">
-                <a class="navbar-brand" href="../..">Midgard v1.1.3</a>
+                <a class="navbar-brand" href="../..">Midgard v1.1.4</a>
                 <!-- Expander button -->
                 <button type="button" class="navbar-toggler" data-toggle="collapse" data-target="#navbar-collapse">
                     <span class="navbar-toggler-icon"></span>
@@ -876,10 +876,10 @@ <h2 id="midgarddevtimer">midgard.dev.timer</h2>
 logger is used to report the timing. See <code>Timer.__init__</code> for more details.</p>
 <h3 id="accumulatedtimer"><strong>AccumulatedTimer</strong></h3>
 <p>Full name: <code>midgard.dev.timer.AccumulatedTimer</code></p>
-<p>Signature: <code>(text: str = 'Elapsed time:', fmt: str = '.4f', logger: Union[Callable[[str], NoneType], NoneType] = functools.partial(&lt;function log at 0x7fa9957b3dc0&gt;, level='info')) -&gt; None</code></p>
+<p>Signature: <code>(text: str = 'Elapsed time:', fmt: str = '.4f', logger: Union[Callable[[str], NoneType], NoneType] = functools.partial(&lt;function log at 0x7fde4edea8b0&gt;, level='info')) -&gt; None</code></p>
 <h3 id="timer"><strong>Timer</strong></h3>
 <p>Full name: <code>midgard.dev.timer.Timer</code></p>
-<p>Signature: <code>(text: str = 'Elapsed time:', fmt: str = '.4f', logger: Union[Callable[[str], NoneType], NoneType] = functools.partial(&lt;function log at 0x7fa9957b3dc0&gt;, level='info')) -&gt; None</code></p>
+<p>Signature: <code>(text: str = 'Elapsed time:', fmt: str = '.4f', logger: Union[Callable[[str], NoneType], NoneType] = functools.partial(&lt;function log at 0x7fde4edea8b0&gt;, level='info')) -&gt; None</code></p>
 <p>Class for timing running time of functions and code blocks.</p>
 <h2 id="midgarddevutil">midgard.dev.util</h2>
 <p>Midgard library module with utility functions for easier script development</p>

diff --git a/docs/api/midgard-files/index.html b/docs/api/midgard-files/index.html
@@ -8,7 +8,7 @@
 
 
         <link rel="shortcut icon" href="../../img/favicon.ico">
-        <title>midgard.files - Midgard v1.1.3</title>
+        <title>midgard.files - Midgard v1.1.4</title>
         <link href="../../css/bootstrap.min.css" rel="stylesheet">
         <link href="../../css/font-awesome.min.css" rel="stylesheet">
         <link href="../../css/base.css" rel="stylesheet">
@@ -23,7 +23,7 @@
     <body>
         <div class="navbar fixed-top navbar-expand-lg navbar-dark bg-primary">
             <div class="container">
-                <a class="navbar-brand" href="../..">Midgard v1.1.3</a>
+                <a class="navbar-brand" href="../..">Midgard v1.1.4</a>
                 <!-- Expander button -->
                 <button type="button" class="navbar-toggler" data-toggle="collapse" data-target="#navbar-collapse">
                     <span class="navbar-toggler-icon"></span>

diff --git a/docs/api/midgard-gnss/index.html b/docs/api/midgard-gnss/index.html
@@ -8,7 +8,7 @@
 
 
         <link rel="shortcut icon" href="../../img/favicon.ico">
-        <title>midgard.gnss - Midgard v1.1.3</title>
+        <title>midgard.gnss - Midgard v1.1.4</title>
         <link href="../../css/bootstrap.min.css" rel="stylesheet">
         <link href="../../css/font-awesome.min.css" rel="stylesheet">
         <link href="../../css/base.css" rel="stylesheet">
@@ -23,7 +23,7 @@
     <body>
         <div class="navbar fixed-top navbar-expand-lg navbar-dark bg-primary">
             <div class="container">
-                <a class="navbar-brand" href="../..">Midgard v1.1.3</a>
+                <a class="navbar-brand" href="../..">Midgard v1.1.4</a>
                 <!-- Expander button -->
                 <button type="button" class="navbar-toggler" data-toggle="collapse" data-target="#navbar-collapse">
                     <span class="navbar-toggler-icon"></span>

diff --git a/docs/api/midgard-ionosphere/index.html b/docs/api/midgard-ionosphere/index.html
@@ -8,7 +8,7 @@
 
 
         <link rel="shortcut icon" href="../../img/favicon.ico">
-        <title>midgard.ionosphere - Midgard v1.1.3</title>
+        <title>midgard.ionosphere - Midgard v1.1.4</title>
         <link href="../../css/bootstrap.min.css" rel="stylesheet">
         <link href="../../css/font-awesome.min.css" rel="stylesheet">
         <link href="../../css/base.css" rel="stylesheet">
@@ -23,7 +23,7 @@
     <body>
         <div class="navbar fixed-top navbar-expand-lg navbar-dark bg-primary">
             <div class="container">
-                <a class="navbar-brand" href="../..">Midgard v1.1.3</a>
+                <a class="navbar-brand" href="../..">Midgard v1.1.4</a>
                 <!-- Expander button -->
                 <button type="button" class="navbar-toggler" data-toggle="collapse" data-target="#navbar-collapse">
                     <span class="navbar-toggler-icon"></span>
@@ -176,7 +176,7 @@ <h2 id="midgardionosphereklobuchar">midgard.ionosphere.klobuchar</h2>
 </ul>
 <h3 id="klobuchar"><strong>klobuchar</strong>()</h3>
 <p>Full name: <code>midgard.ionosphere.klobuchar.klobuchar</code></p>
-<p>Signature: <code>(time, ion_coeffs, rec_pos, az, el, freq_l1, freq=None, logger=functools.partial(&lt;function log at 0x7fa9957b3dc0&gt;, level='debug'))</code></p>
+<p>Signature: <code>(time, ion_coeffs, rec_pos, az, el, freq_l1, freq=None, logger=functools.partial(&lt;function log at 0x7fde4edea8b0&gt;, level='debug'))</code></p>
 <p>Compute the ionospheric time-delay correction for the single-frequency by broadcast  model (klobuchar model)</p>
 <p>GPS and  BeiDou satellite navigation systems use this model. The implementation is based on original paper of
 Klobuchar, J.A. Ionospheric Time-Delay Algorithm for Single-Frequency GPS Users

diff --git a/docs/api/midgard-math/index.html b/docs/api/midgard-math/index.html
@@ -8,7 +8,7 @@
 
 
         <link rel="shortcut icon" href="../../img/favicon.ico">
-        <title>midgard.math - Midgard v1.1.3</title>
+        <title>midgard.math - Midgard v1.1.4</title>
         <link href="../../css/bootstrap.min.css" rel="stylesheet">
         <link href="../../css/font-awesome.min.css" rel="stylesheet">
         <link href="../../css/base.css" rel="stylesheet">
@@ -23,7 +23,7 @@
     <body>
         <div class="navbar fixed-top navbar-expand-lg navbar-dark bg-primary">
             <div class="container">
-                <a class="navbar-brand" href="../..">Midgard v1.1.3</a>
+                <a class="navbar-brand" href="../..">Midgard v1.1.4</a>
                 <!-- Expander button -->
                 <button type="button" class="navbar-toggler" data-toggle="collapse" data-target="#navbar-collapse">
                     <span class="navbar-toggler-icon"></span>

diff --git a/docs/api/midgard-parsers/index.html b/docs/api/midgard-parsers/index.html
@@ -8,7 +8,7 @@
 
 
         <link rel="shortcut icon" href="../../img/favicon.ico">
-        <title>midgard.parsers - Midgard v1.1.3</title>
+        <title>midgard.parsers - Midgard v1.1.4</title>
         <link href="../../css/bootstrap.min.css" rel="stylesheet">
         <link href="../../css/font-awesome.min.css" rel="stylesheet">
         <link href="../../css/base.css" rel="stylesheet">
@@ -23,7 +23,7 @@
     <body>
         <div class="navbar fixed-top navbar-expand-lg navbar-dark bg-primary">
             <div class="container">
-                <a class="navbar-brand" href="../..">Midgard v1.1.3</a>
+                <a class="navbar-brand" href="../..">Midgard v1.1.4</a>
                 <!-- Expander button -->
                 <button type="button" class="navbar-toggler" data-toggle="collapse" data-target="#navbar-collapse">
                     <span class="navbar-toggler-icon"></span>
@@ -168,6 +168,10 @@
               <ul class="nav flex-column">
               </ul>
             </li>
+            <li class="nav-item" data-level="2"><a href="#midgardparserscost" class="nav-link">midgard.parsers.cost</a>
+              <ul class="nav flex-column">
+              </ul>
+            </li>
             <li class="nav-item" data-level="2"><a href="#midgardparserscsv_" class="nav-link">midgard.parsers.csv_</a>
               <ul class="nav flex-column">
               </ul>
@@ -702,6 +706,40 @@ <h3 id="bcecmpparser"><strong>BcecmpParser</strong></h3>
 </tr>
 </tbody>
 </table>
+<h2 id="midgardparserscost">midgard.parsers.cost</h2>
+<p>A parser for reading COST format for ground-based GNSS delay and water vapour data</p>
+<p><strong>Example:</strong></p>
+<pre><code>from midgard import parsers
+
+# Parse data
+parser = parsers.parse_file(parser_name="cost", file_path=file_path)
+
+# Get Dataset with parsed data
+dset = parser.as_dataset()
+</code></pre>
+<p><strong>Description:</strong></p>
+<p>Reads data from files in the COST file format 2.2a (see :cite:<code>cost</code>).</p>
+<h3 id="costparser"><strong>CostParser</strong></h3>
+<p>Full name: <code>midgard.parsers.cost.CostParser</code></p>
+<p>Signature: <code>(file_path: Union[str, pathlib.Path], encoding: Union[str, NoneType] = None) -&gt; None</code></p>
+<p>A parser for reading COST datan file</p>
+<p>The parser reads ground-based GNSS delay and water vapour data in COST format version 2.2a.</p>
+<p><strong>Attributes:</strong></p>
+<p>data (Dict):                  The (observation) data read from file.
+data_available (Boolean):     Indicator of whether data are available.
+file_encoding (String):       Encoding of the datafile.
+file_path (Path):             Path to the datafile that will be read.
+meta (Dict):                  Metainformation read from file.
+parser_name (String):         Name of the parser (as needed to call parsers.parse_...).</p>
+<h3 id="unit_def-dict">UNIT_DEF (dict)</h3>
+<p><code>UNIT_DEF = {'gradients_ew': UnitField(from_='millimeter', to_='meter'), 'gradients_ns': UnitField(from_='millimeter', to_='meter'), 'height_geoid': UnitField(from_='meter', to_='meter'), 'humidity': UnitField(from_='', to_=''), 'iwv': UnitField(from_='kilogram/meter**2', to_='kilogram/meter**2'), 'pressure': UnitField(from_='hectopascal', to_='pascal'), 'sigma_gradients_ew': UnitField(from_='millimeter', to_='meter'), 'sigma_gradients_ns': UnitField(from_='millimeter', to_='meter'), 'sigma_ztd': UnitField(from_='millimeter', to_='meter'), 'temperature': UnitField(from_='kelvin', to_='kelvin'), 'ztd': UnitField(from_='millimeter', to_='meter'), 'zwd': UnitField(from_='millimeter', to_='meter')}</code></p>
+<h3 id="unitfield"><strong>UnitField</strong></h3>
+<p>Full name: <code>midgard.parsers.cost.UnitField</code></p>
+<p>Signature: <code>(from_=None, to_=None)</code></p>
+<p>A convenience class for defining a COST units of fields</p>
+<p><strong>Args:</strong></p>
+<p>from (str):              Original field unit
+to (str):                Destination field unit</p>
 <h2 id="midgardparserscsv_">midgard.parsers.csv_</h2>
 <p>A parser for reading CSV output files</p>
 <p><strong>Example:</strong></p>

diff --git a/docs/api/midgard-plot/index.html b/docs/api/midgard-plot/index.html
@@ -8,7 +8,7 @@
 
 
         <link rel="shortcut icon" href="../../img/favicon.ico">
-        <title>midgard.plot - Midgard v1.1.3</title>
+        <title>midgard.plot - Midgard v1.1.4</title>
         <link href="../../css/bootstrap.min.css" rel="stylesheet">
         <link href="../../css/font-awesome.min.css" rel="stylesheet">
         <link href="../../css/base.css" rel="stylesheet">
@@ -23,7 +23,7 @@
     <body>
         <div class="navbar fixed-top navbar-expand-lg navbar-dark bg-primary">
             <div class="container">
-                <a class="navbar-brand" href="../..">Midgard v1.1.3</a>
+                <a class="navbar-brand" href="../..">Midgard v1.1.4</a>
                 <!-- Expander button -->
                 <button type="button" class="navbar-toggler" data-toggle="collapse" data-target="#navbar-collapse">
                     <span class="navbar-toggler-icon"></span>

diff --git a/docs/api/midgard-site_info/index.html b/docs/api/midgard-site_info/index.html
@@ -8,7 +8,7 @@
 
 
         <link rel="shortcut icon" href="../../img/favicon.ico">
-        <title>midgard.site_info - Midgard v1.1.3</title>
+        <title>midgard.site_info - Midgard v1.1.4</title>
         <link href="../../css/bootstrap.min.css" rel="stylesheet">
         <link href="../../css/font-awesome.min.css" rel="stylesheet">
         <link href="../../css/base.css" rel="stylesheet">
@@ -23,7 +23,7 @@
     <body>
         <div class="navbar fixed-top navbar-expand-lg navbar-dark bg-primary">
             <div class="container">
-                <a class="navbar-brand" href="../..">Midgard v1.1.3</a>
+                <a class="navbar-brand" href="../..">Midgard v1.1.4</a>
                 <!-- Expander button -->
                 <button type="button" class="navbar-toggler" data-toggle="collapse" data-target="#navbar-collapse">
                     <span class="navbar-toggler-icon"></span>

diff --git a/docs/api/midgard-writers/index.html b/docs/api/midgard-writers/index.html
@@ -8,7 +8,7 @@
 
 
         <link rel="shortcut icon" href="../../img/favicon.ico">
-        <title>midgard.writers - Midgard v1.1.3</title>
+        <title>midgard.writers - Midgard v1.1.4</title>
         <link href="../../css/bootstrap.min.css" rel="stylesheet">
         <link href="../../css/font-awesome.min.css" rel="stylesheet">
         <link href="../../css/base.css" rel="stylesheet">
@@ -23,7 +23,7 @@
     <body>
         <div class="navbar fixed-top navbar-expand-lg navbar-dark bg-primary">
             <div class="container">
-                <a class="navbar-brand" href="../..">Midgard v1.1.3</a>
+                <a class="navbar-brand" href="../..">Midgard v1.1.4</a>
                 <!-- Expander button -->
                 <button type="button" class="navbar-toggler" data-toggle="collapse" data-target="#navbar-collapse">
                     <span class="navbar-toggler-icon"></span>

diff --git a/docs/api/midgard/index.html b/docs/api/midgard/index.html
@@ -8,7 +8,7 @@
 
 
         <link rel="shortcut icon" href="../../img/favicon.ico">
-        <title>midgard - Midgard v1.1.3</title>
+        <title>midgard - Midgard v1.1.4</title>
         <link href="../../css/bootstrap.min.css" rel="stylesheet">
         <link href="../../css/font-awesome.min.css" rel="stylesheet">
         <link href="../../css/base.css" rel="stylesheet">
@@ -23,7 +23,7 @@
     <body>
         <div class="navbar fixed-top navbar-expand-lg navbar-dark bg-primary">
             <div class="container">
-                <a class="navbar-brand" href="../..">Midgard v1.1.3</a>
+                <a class="navbar-brand" href="../..">Midgard v1.1.4</a>
                 <!-- Expander button -->
                 <button type="button" class="navbar-toggler" data-toggle="collapse" data-target="#navbar-collapse">
                     <span class="navbar-toggler-icon"></span>