Release version 1.2.1

kartverket · Jan 11, 2023 · 3b48c4b · 3b48c4b
1 parent fc668db
commit 3b48c4b
Show file tree

Hide file tree

Showing 33 changed files with 964 additions and 600 deletions.
diff --git a/.bumpversion.cfg b/.bumpversion.cfg
@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 1.2.0
+current_version = 1.2.1
 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.2.0</title>
+ <title>Midgard v1.2.1</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.2.0</a>
+ <a class="navbar-brand" href="/.">Midgard v1.2.1</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.2.0</title>
+ <title>midgard.collections - Midgard v1.2.1</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.2.0</a>
+ <a class="navbar-brand" href="../..">Midgard v1.2.1</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.2.0</title>
+ <title>midgard.config - Midgard v1.2.1</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.2.0</a>
+ <a class="navbar-brand" href="../..">Midgard v1.2.1</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 0x7fa644ae8780&gt;, converters=&lt;object object at 0x7fa644ae8780&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 0x7f6bf5df63a0&gt;, converters=&lt;object object at 0x7f6bf5df63a0&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.2.0</title>
+ <title>midgard.data - Midgard v1.2.1</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.2.0</a>
+ <a class="navbar-brand" href="../..">Midgard v1.2.1</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.2.0</title>
+ <title>midgard.dev - Midgard v1.2.1</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.2.0</a>
+ <a class="navbar-brand" href="../..">Midgard v1.2.1</a>
  <!-- Expander button -->
  <button type="button" class="navbar-toggler" data-toggle="collapse" data-target="#navbar-collapse">
  <span class="navbar-toggler-icon"></span>
@@ -771,7 +771,7 @@ <h3 id="register"><strong>register</strong>()</h3>
 <p>If <code>name</code> is given, the plug-in is registered based on this name instead of
 the name of the module. The name of the module is still registered as a
 part that can be used to distinguish between similar plug-ins in different
-files (see for instance how <code>session</code> is used in <code>midgard.pipelines</code>).</p>
+files.</p>
 <p><strong>Args:</strong></p>
 <ul>
 <li><code>func</code>: The function that is being registered.</li>
@@ -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: Optional[Callable[[str], NoneType]] = functools.partial(&lt;function log at 0x7fa6578b4550&gt;, level='info')) -&gt; None</code></p>
+<p>Signature: <code>(text: str = 'Elapsed time:', fmt: str = '.4f', logger: Optional[Callable[[str], NoneType]] = functools.partial(&lt;function log at 0x7f6bf7042550&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: Optional[Callable[[str], NoneType]] = functools.partial(&lt;function log at 0x7fa6578b4550&gt;, level='info')) -&gt; None</code></p>
+<p>Signature: <code>(text: str = 'Elapsed time:', fmt: str = '.4f', logger: Optional[Callable[[str], NoneType]] = functools.partial(&lt;function log at 0x7f6bf7042550&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.2.0</title>
+ <title>midgard.files - Midgard v1.2.1</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.2.0</a>
+ <a class="navbar-brand" href="../..">Midgard v1.2.1</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.2.0</title>
+ <title>midgard.gnss - Midgard v1.2.1</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.2.0</a>
+ <a class="navbar-brand" href="../..">Midgard v1.2.1</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.2.0</title>
+ <title>midgard.ionosphere - Midgard v1.2.1</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.2.0</a>
+ <a class="navbar-brand" href="../..">Midgard v1.2.1</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 0x7fa6578b4550&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 0x7f6bf7042550&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.2.0</title>
+ <title>midgard.math - Midgard v1.2.1</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.2.0</a>
+ <a class="navbar-brand" href="../..">Midgard v1.2.1</a>
  <!-- Expander button -->
  <button type="button" class="navbar-toggler" data-toggle="collapse" data-target="#navbar-collapse">
  <span class="navbar-toggler-icon"></span>
@@ -156,6 +156,21 @@
  <ul class="nav flex-column">
  </ul>
  </li>
+ </ul>
+ </li>
+
+ <li class="nav-item" data-level="1"><a href="#import-midgard-linearregression-class-of-linear_regression-module" class="nav-link">Import Midgard LinearRegression class of linear_regression module</a>
+ <ul class="nav flex-column">
+ </ul>
+ </li>
+
+ <li class="nav-item" data-level="1"><a href="#generate-linearregression-object" class="nav-link">Generate LinearRegression object</a>
+ <ul class="nav flex-column">
+ </ul>
+ </li>
+
+ <li class="nav-item" data-level="1"><a href="#get-solution" class="nav-link">Get solution</a>
+ <ul class="nav flex-column">
  <li class="nav-item" data-level="2"><a href="#midgardmathnputil" class="nav-link">midgard.math.nputil</a>
  <ul class="nav flex-column">
  </ul>
@@ -413,11 +428,39 @@ <h3 id="register_interpolator"><strong>register_interpolator</strong>()</h3>
 <p>Same function.</p>
 <h2 id="midgardmathlinear_regression">midgard.math.linear_regression</h2>
 <p>Midgard library module for linear regression</p>
-<p><strong>Description:</strong></p>
+<p><strong>Description:</strong>
+The 'statsmodels' module is used for the linear regression. Outlier can be rejected beside normal linear regression 
+analysis. Hereby a linear regression analysis is carried out, whereby a linear trend is estimated of the given data.
+The root-mean square (RMS) of the residuals (observation - linear trend) is used to detect outliers. As default
+the following outlier limit is defined: </p>
+<pre><code>limit = outlier_limit_factor * RMS (with outlier_limit_factor=1.0)
+</code></pre>
+<p>The 'outlier_limit_factor' can be chosen as argument by initialization of a LinearRegression class object. In addition
+the number of iteration for the outlier detection can be chosen with the argument 'outlier_iteration'.</p>
+<p><strong>Example:</strong></p>
+<h1 id="import-midgard-linearregression-class-of-linear_regression-module">Import Midgard LinearRegression class of linear_regression module</h1>
+<p>from midgard.math.linear_regression import LinearRegression</p>
+<h1 id="generate-linearregression-object">Generate LinearRegression object</h1>
+<p>linreg = LinearRegression(x,y)</p>
+<h1 id="get-solution">Get solution</h1>
+<p>interception = linreg.interception
+slope = linreg.slope</p>
 <h3 id="linearregression"><strong>LinearRegression</strong></h3>
 <p>Full name: <code>midgard.math.linear_regression.LinearRegression</code></p>
-<p>Signature: <code>(x: numpy.ndarray, y: numpy.ndarray) -&gt; None</code></p>
-<p>LinearRegression(x: numpy.ndarray, y: numpy.ndarray)</p>
+<p>Signature: <code>(x: Union[numpy.ndarray, list], y: Union[numpy.ndarray, list], reject_outlier: bool = False, outlier_limit_factor: float = 1.0, outlier_iteration: int = 1) -&gt; None</code></p>
+<p>Linear regression class</p>
+<p>Following arguments can be chosen by initialization of LinearRegression class objects:</p>
+<pre><code>| Arguments | Type | Description |
+|:----------------------| :----------| :---------------------------------------------------------------------|
+| outlier_limit_factor | float | RMS of residuals are used for detecting outliers, whereby |
+| | | 'outlier_limit_factor' * 'RMS' is used as limit. As default is |
+| | | 'outlier_limit_factor' = 1.0 chosen. |
+| outlier_iteration | int | Number of iteration used to detect and reject outliers. Default is 1. |
+| reject_outlier | bool | Determine if outliers should be detected and rejected. Default is |
+| | | 'False', which means that no outliers are rejected. |
+| x | np.ndarray | X training data |
+| y | np.ndarray | Y target data |
+</code></pre>
 <h2 id="midgardmathnputil">midgard.math.nputil</h2>
 <p>Utility wrapper for numpy functions</p>
 <p>Makes sure numpy functions can be called in a similar fashion for different use cases
@@ -789,8 +832,6 @@ <h3 id="unit"><strong>Unit</strong></h3>
 <p>Signature: <code>(from_unit: str, to_unit: Optional[str] = None) -&gt; Any</code></p>
 <p>Unit converter</p>
 <p>The implementation of the unit conversion is done in the <code>_convert_units</code>-metaclass.</p>
-<h3 id="fid-textiowrapper">fid (TextIOWrapper)</h3>
-<p><code>fid = &lt;_io.TextIOWrapper name='/home/kirann/miniconda3/lib/python3.9/site-packages/midgard/math/unit.txt' encoding='utf-8'&gt;</code></p>
 <h3 id="np_float-typevar_1">np_float (TypeVar)</h3>
 <p><code>np_float = ~np_float</code></p></div>
  </div>