docs: build docs

CHANGELOG.md

@@ -1,3 +1,28 @@
+## v8.2.1
+* chore(deps): update pre-commit hook commitizen-tools/commitizen to v3.8.0 in #1
+* chore(deps): lock file maintenance in #3
+* chore(deps): update pre-commit hook commitizen-tools/commitizen to v3.8.1 in #4
+* chore(deps): update pre-commit hook psf/black to v23.9.0 in #5
+* chore(deps): update pre-commit hook commitizen-tools/commitizen to v3.8.2 in #7
+* fix: pandas future (deprecation) warnings  in #9
+* chore(deps): update pre-commit hook psf/black to v23.9.1 in #12
+* chore: deprecate support for python 3.8 in #10
+* fix(deps): update dependency numpy to v1.25.2 in #14
+* docs: rename master with main  in #19
+* docs: change support email  in #17
+* chore(deps): update dependency ruff to ^0.0.288 in #20
+* chore(deps): update pre-commit hook astral-sh/ruff-pre-commit to v0.0.288 in #21
+* docs: update compiled doc files  in #22
+* chore(deps): update dependency ruff to ^0.0.289 in #23
+* chore(deps): update pre-commit hook astral-sh/ruff-pre-commit to v0.0.289 in #24
+* fix: cannot find function version in #26
+* chore: remove python 3.8 for CI test extras  in #29
+* docs: build documentation  in #28
+* chore(deps): update pre-commit hook pre-commit/pre-commit-hooks to v4.5.0 in #16
+* chore(deps): update pre-commit hook pre-commit/mirrors-mypy to v1.6.0 in #15
+* chore(deps): update dependency docstring-to-markdown to v0.12 in #13
+* fix: corrected types by @anvar-akhiiartdinov in #31
+* chore(deps-dev): bump urllib3 from 2.0.6 to 2.0.7  in #27
 ## v8.2.0
 * fix(deps): update dependency numpy to v1.25.1 in #1056
 * chore(deps): update pre-commit hook commitizen-tools/commitizen to v3.5.4 in #1058

PUBLISHING.md

@@ -10,6 +10,7 @@ The workflow for publishing the `indsl` library consists of bumping the version
         If you want this to be a prerelease, set an environment variable INPUT_PRERELEASE to `alpha`, `beta` or `rc` on the parameter
 
     3. Modify the CHANGELOG.md if needed and commit the changes for `CHANGELOG.md`, `pyproject.toml`.
+    (Make sure that indsl version is updated in `pyproject.toml`)
     4. Push the branch to github
     5. Push the new tag to github: `git push origin --tags`
     6. Create a PR and ask someone in the Cognite `Charts InDSL Review` to approve and merge.

docs-source/source/CHANGELOG.md

@@ -1,4 +1,29 @@
 # Changelog
+## v8.2.1
+* chore(deps): update pre-commit hook commitizen-tools/commitizen to v3.8.0 in #1
+* chore(deps): lock file maintenance in #3
+* chore(deps): update pre-commit hook commitizen-tools/commitizen to v3.8.1 in #4
+* chore(deps): update pre-commit hook psf/black to v23.9.0 in #5
+* chore(deps): update pre-commit hook commitizen-tools/commitizen to v3.8.2 in #7
+* fix: pandas future (deprecation) warnings  in #9
+* chore(deps): update pre-commit hook psf/black to v23.9.1 in #12
+* chore: deprecate support for python 3.8 in #10
+* fix(deps): update dependency numpy to v1.25.2 in #14
+* docs: rename master with main  in #19
+* docs: change support email  in #17
+* chore(deps): update dependency ruff to ^0.0.288 in #20
+* chore(deps): update pre-commit hook astral-sh/ruff-pre-commit to v0.0.288 in #21
+* docs: update compiled doc files  in #22
+* chore(deps): update dependency ruff to ^0.0.289 in #23
+* chore(deps): update pre-commit hook astral-sh/ruff-pre-commit to v0.0.289 in #24
+* fix: cannot find function version in #26
+* chore: remove python 3.8 for CI test extras  in #29
+* docs: build documentation  in #28
+* chore(deps): update pre-commit hook pre-commit/pre-commit-hooks to v4.5.0 in #16
+* chore(deps): update pre-commit hook pre-commit/mirrors-mypy to v1.6.0 in #15
+* chore(deps): update dependency docstring-to-markdown to v0.12 in #13
+* fix: corrected types by @anvar-akhiiartdinov in #31
+* chore(deps-dev): bump urllib3 from 2.0.6 to 2.0.7  in #27
 ## v8.2.0
 * fix(deps): update dependency numpy to v1.25.1 in #1056
 * chore(deps): update pre-commit hook commitizen-tools/commitizen to v3.5.4 in #1058

docs/CHANGELOG.html

@@ -87,6 +87,7 @@
 <li class="toctree-l1"><a class="reference internal" href="code_of_conduct.html">Code of Conduct</a></li>
 <li class="toctree-l1"><a class="reference internal" href="dev_tools.html">Developer utility functions</a></li>
 <li class="toctree-l1 current"><a class="current reference internal" href="#">Changelog</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="#v8-2-1">v8.2.1</a></li>
 <li class="toctree-l2"><a class="reference internal" href="#v8-2-0">v8.2.0</a></li>
 <li class="toctree-l2"><a class="reference internal" href="#v8-1-0">v8.1.0</a><ul>
 <li class="toctree-l3"><a class="reference internal" href="#feat">Feat</a></li>
@@ -362,6 +363,35 @@
 
   <section id="changelog">
 <h1>Changelog<a class="headerlink" href="#changelog" title="Link to this heading"></a></h1>
+<section id="v8-2-1">
+<h2>v8.2.1<a class="headerlink" href="#v8-2-1" title="Link to this heading"></a></h2>
+<ul class="simple">
+<li><p>chore(deps): update pre-commit hook commitizen-tools/commitizen to v3.8.0 in #1</p></li>
+<li><p>chore(deps): lock file maintenance in #3</p></li>
+<li><p>chore(deps): update pre-commit hook commitizen-tools/commitizen to v3.8.1 in #4</p></li>
+<li><p>chore(deps): update pre-commit hook psf/black to v23.9.0 in #5</p></li>
+<li><p>chore(deps): update pre-commit hook commitizen-tools/commitizen to v3.8.2 in #7</p></li>
+<li><p>fix: pandas future (deprecation) warnings  in #9</p></li>
+<li><p>chore(deps): update pre-commit hook psf/black to v23.9.1 in #12</p></li>
+<li><p>chore: deprecate support for python 3.8 in #10</p></li>
+<li><p>fix(deps): update dependency numpy to v1.25.2 in #14</p></li>
+<li><p>docs: rename master with main  in #19</p></li>
+<li><p>docs: change support email  in #17</p></li>
+<li><p>chore(deps): update dependency ruff to ^0.0.288 in #20</p></li>
+<li><p>chore(deps): update pre-commit hook astral-sh/ruff-pre-commit to v0.0.288 in #21</p></li>
+<li><p>docs: update compiled doc files  in #22</p></li>
+<li><p>chore(deps): update dependency ruff to ^0.0.289 in #23</p></li>
+<li><p>chore(deps): update pre-commit hook astral-sh/ruff-pre-commit to v0.0.289 in #24</p></li>
+<li><p>fix: cannot find function version in #26</p></li>
+<li><p>chore: remove python 3.8 for CI test extras  in #29</p></li>
+<li><p>docs: build documentation  in #28</p></li>
+<li><p>chore(deps): update pre-commit hook pre-commit/pre-commit-hooks to v4.5.0 in #16</p></li>
+<li><p>chore(deps): update pre-commit hook pre-commit/mirrors-mypy to v1.6.0 in #15</p></li>
+<li><p>chore(deps): update dependency docstring-to-markdown to v0.12 in #13</p></li>
+<li><p>fix: corrected types by &#64;anvar-akhiiartdinov in #31</p></li>
+<li><p>chore(deps-dev): bump urllib3 from 2.0.6 to 2.0.7  in #27</p></li>
+</ul>
+</section>
 <section id="v8-2-0">
 <h2>v8.2.0<a class="headerlink" href="#v8-2-0" title="Link to this heading"></a></h2>
 <ul class="simple">

docs/_sources/CHANGELOG.md.txt

@@ -1,4 +1,29 @@
 # Changelog
+## v8.2.1
+* chore(deps): update pre-commit hook commitizen-tools/commitizen to v3.8.0 in #1
+* chore(deps): lock file maintenance in #3
+* chore(deps): update pre-commit hook commitizen-tools/commitizen to v3.8.1 in #4
+* chore(deps): update pre-commit hook psf/black to v23.9.0 in #5
+* chore(deps): update pre-commit hook commitizen-tools/commitizen to v3.8.2 in #7
+* fix: pandas future (deprecation) warnings  in #9
+* chore(deps): update pre-commit hook psf/black to v23.9.1 in #12
+* chore: deprecate support for python 3.8 in #10
+* fix(deps): update dependency numpy to v1.25.2 in #14
+* docs: rename master with main  in #19
+* docs: change support email  in #17
+* chore(deps): update dependency ruff to ^0.0.288 in #20
+* chore(deps): update pre-commit hook astral-sh/ruff-pre-commit to v0.0.288 in #21
+* docs: update compiled doc files  in #22
+* chore(deps): update dependency ruff to ^0.0.289 in #23
+* chore(deps): update pre-commit hook astral-sh/ruff-pre-commit to v0.0.289 in #24
+* fix: cannot find function version in #26
+* chore: remove python 3.8 for CI test extras  in #29
+* docs: build documentation  in #28
+* chore(deps): update pre-commit hook pre-commit/pre-commit-hooks to v4.5.0 in #16
+* chore(deps): update pre-commit hook pre-commit/mirrors-mypy to v1.6.0 in #15
+* chore(deps): update dependency docstring-to-markdown to v0.12 in #13
+* fix: corrected types by @anvar-akhiiartdinov in #31
+* chore(deps-dev): bump urllib3 from 2.0.6 to 2.0.7  in #27
 ## v8.2.0
 * fix(deps): update dependency numpy to v1.25.1 in #1056
 * chore(deps): update pre-commit hook commitizen-tools/commitizen to v3.5.4 in #1058

docs/_sources/auto_examples/data_quality/sg_execution_times.rst.txt

@@ -6,10 +6,10 @@
 
 Computation times
 =================
-**00:02.912** total execution time for **auto_examples_data_quality** files:
+**00:02.605** total execution time for **auto_examples_data_quality** files:
 
 +------------------------------------------------------------------------------------------------------------------------+-----------+--------+
-| :ref:`sphx_glr_auto_examples_data_quality_plot_datapoint_diff.py` (``plot_datapoint_diff.py``)                         | 00:02.912 | 0.0 MB |
+| :ref:`sphx_glr_auto_examples_data_quality_plot_datapoint_diff.py` (``plot_datapoint_diff.py``)                         | 00:02.605 | 0.0 MB |
 +------------------------------------------------------------------------------------------------------------------------+-----------+--------+
 | :ref:`sphx_glr_auto_examples_data_quality_plot_completeness.py` (``plot_completeness.py``)                             | 00:00.000 | 0.0 MB |
 +------------------------------------------------------------------------------------------------------------------------+-----------+--------+

docs/_sources/auto_examples/detect/sg_execution_times.rst.txt

@@ -6,10 +6,10 @@
 
 Computation times
 =================
-**00:01.319** total execution time for **auto_examples_detect** files:
+**00:01.182** total execution time for **auto_examples_detect** files:
 
 +------------------------------------------------------------------------------------------------------------------+-----------+--------+
-| :ref:`sphx_glr_auto_examples_detect_plot_oscillation_detection.py` (``plot_oscillation_detection.py``)           | 00:01.319 | 0.0 MB |
+| :ref:`sphx_glr_auto_examples_detect_plot_oscillation_detection.py` (``plot_oscillation_detection.py``)           | 00:01.182 | 0.0 MB |
 +------------------------------------------------------------------------------------------------------------------+-----------+--------+
 | :ref:`sphx_glr_auto_examples_detect_plot_cusum.py` (``plot_cusum.py``)                                           | 00:00.000 | 0.0 MB |
 +------------------------------------------------------------------------------------------------------------------+-----------+--------+

docs/auto_examples/data_quality/sg_execution_times.html

@@ -114,11 +114,11 @@
 
   <section id="computation-times">
 <span id="sphx-glr-auto-examples-data-quality-sg-execution-times"></span><h1>Computation times<a class="headerlink" href="#computation-times" title="Link to this heading"></a></h1>
-<p><strong>00:02.912</strong> total execution time for <strong>auto_examples_data_quality</strong> files:</p>
+<p><strong>00:02.605</strong> total execution time for <strong>auto_examples_data_quality</strong> files:</p>
 <table class="docutils align-default">
 <tbody>
 <tr class="row-odd"><td><p><a class="reference internal" href="plot_datapoint_diff.html#sphx-glr-auto-examples-data-quality-plot-datapoint-diff-py"><span class="std std-ref">Threshold breach check for difference between two data points over a period of time</span></a> (<code class="docutils literal notranslate"><span class="pre">plot_datapoint_diff.py</span></code>)</p></td>
-<td><p>00:02.912</p></td>
+<td><p>00:02.605</p></td>
 <td><p>0.0 MB</p></td>
 </tr>
 <tr class="row-even"><td><p><a class="reference internal" href="plot_completeness.html#sphx-glr-auto-examples-data-quality-plot-completeness-py"><span class="std std-ref">Completeness score of time series</span></a> (<code class="docutils literal notranslate"><span class="pre">plot_completeness.py</span></code>)</p></td>

docs/auto_examples/detect/sg_execution_times.html

@@ -114,11 +114,11 @@
 
   <section id="computation-times">
 <span id="sphx-glr-auto-examples-detect-sg-execution-times"></span><h1>Computation times<a class="headerlink" href="#computation-times" title="Link to this heading"></a></h1>
-<p><strong>00:01.319</strong> total execution time for <strong>auto_examples_detect</strong> files:</p>
+<p><strong>00:01.182</strong> total execution time for <strong>auto_examples_detect</strong> files:</p>
 <table class="docutils align-default">
 <tbody>
 <tr class="row-odd"><td><p><a class="reference internal" href="plot_oscillation_detection.html#sphx-glr-auto-examples-detect-plot-oscillation-detection-py"><span class="std std-ref">Oscillation detection using linear predictive coding</span></a> (<code class="docutils literal notranslate"><span class="pre">plot_oscillation_detection.py</span></code>)</p></td>
-<td><p>00:01.319</p></td>
+<td><p>00:01.182</p></td>
 <td><p>0.0 MB</p></td>
 </tr>
 <tr class="row-even"><td><p><a class="reference internal" href="plot_cusum.html#sphx-glr-auto-examples-detect-plot-cusum-py"><span class="std std-ref">Change Point Detection with Cusum</span></a> (<code class="docutils literal notranslate"><span class="pre">plot_cusum.py</span></code>)</p></td>

docs/index.html

@@ -276,6 +276,7 @@ <h2>Installation<a class="headerlink" href="#installation" title="Link to this h
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="CHANGELOG.html">Changelog</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="CHANGELOG.html#v8-2-1">v8.2.1</a></li>
 <li class="toctree-l2"><a class="reference internal" href="CHANGELOG.html#v8-2-0">v8.2.0</a></li>
 <li class="toctree-l2"><a class="reference internal" href="CHANGELOG.html#v8-1-0">v8.1.0</a></li>
 <li class="toctree-l2"><a class="reference internal" href="CHANGELOG.html#v8-0-1">v8.0.1</a></li>

docs/oil_and_gas.html

@@ -226,7 +226,7 @@ <h2>Productivity index<a class="headerlink" href="#productivity-index" title="Li
 <h2>Shut-in detector<a class="headerlink" href="#shut-in-detector" title="Link to this heading"></a></h2>
 <dl class="py function">
 <dt class="sig sig-object py" id="indsl.oil_and_gas.calculate_shutin_interval">
-<span class="sig-prename descclassname"><span class="pre">indsl.oil_and_gas.</span></span><span class="sig-name descname"><span class="pre">calculate_shutin_interval</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">shut_valve</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Series</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">min_shutin_len</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">6</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">min_time_btw_shutins</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">shutin_state_below_threshold</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">shutin_threshold</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">Series</span></span></span><a class="headerlink" href="#indsl.oil_and_gas.calculate_shutin_interval" title="Link to this definition"></a></dt>
+<span class="sig-prename descclassname"><span class="pre">indsl.oil_and_gas.</span></span><span class="sig-name descname"><span class="pre">calculate_shutin_interval</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">shut_valve</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Series</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">min_shutin_len</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">6</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">min_time_btw_shutins</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">shutin_state_below_threshold</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">shutin_threshold</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">Series</span></span></span><a class="headerlink" href="#indsl.oil_and_gas.calculate_shutin_interval" title="Link to this definition"></a></dt>
 <dd><p>Shut-in interval.</p>
 <p>The shut-in interval is defined as the period when the valve is in closed state. The close state is determined based
 on the calculated manually-given threshold. The threshold is calculated based on the analysis of the valve signal

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "indsl"
-version = "8.2.0"
+version = "8.2.1"
 description = "Industrial Data Science Library by Cognite"
 authors = ["Cognite"]
 license = "Apache-2.0"
@@ -124,7 +124,7 @@ known-third-party = ["pytest"]
 
 [tool.commitizen]
 name = "cz_conventional_commits"
-version = "8.2.0"
+version = "8.2.1"
 tag_format = "v$version"
 version_files = ["pyproject.toml:version"]