Update documentation

Author: PierreRaybaut

en/.doctrees/contributing/changelog.doctree

@@ -67,7 +67,7 @@ code completion, you can add the `cdl` package to your Python path.
 This can be done:
 
 - By installing DataLab in your Python environment (using one of the following methods:
-  :ref:`install_pip`, :ref:`install_wheel`, or :ref:`install_source`),
+  :ref:`install_conda`, :ref:`install_pip`, :ref:`install_wheel`, or :ref:`install_source`),
 
 - Or by adding the `cdl` package to your Python path manually:
 

en/.doctrees/environment.pickle

@@ -32,6 +32,8 @@ How to install
 
 DataLab is available in several forms:
 
+-   As a :ref:`install_conda`.
+
 -   As a Python package, which can be installed using the :ref:`install_pip`.
 
 -   :bdg-info-line:`Windows` As a stand-alone application, which does not require any
@@ -51,6 +53,19 @@ DataLab is available in several forms:
     latest development version of DataLab from the master branch of the
     Git repository. See :ref:`install_development` for more information.
 
+.. _install_conda:
+
+Conda package
+^^^^^^^^^^^^^
+
+:octicon:`info;1em;sd-text-info` :bdg-info-line:`GNU/Linux` :bdg-info-line:`Windows` :bdg-info-line:`macOS`
+
+To install ``datalab`` package from the `conda-forge` channel (https://anaconda.org/conda-forge/datalab), run the following command:
+
+.. code-block:: console
+
+    $ conda install conda-forge::datalab
+
 .. _install_pip:
 
 Package manager ``pip``

en/.doctrees/features/general/plugins.doctree

@@ -976,12 +976,12 @@ <h2>Common parameters<a class="headerlink" href="#common-parameters" title="Link
 
 <dl class="py method">
 <dt class="sig sig-object py">
-<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">create</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">roidata</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray" title="(in NumPy v2.0)"><span class="pre">numpy.ndarray</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">singleobj</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.12)"><span class="pre">bool</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="computation.html#cdl.computation.base.ROIDataParam" title="cdl.computation.base.ROIDataParam"><span class="pre">cdl.computation.base.ROIDataParam</span></a></span></span></dt>
+<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">create</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">roidata</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray" title="(in NumPy v2.1)"><span class="pre">numpy.ndarray</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">singleobj</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.12)"><span class="pre">bool</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="computation.html#cdl.computation.base.ROIDataParam" title="cdl.computation.base.ROIDataParam"><span class="pre">cdl.computation.base.ROIDataParam</span></a></span></span></dt>
 <dd><p>Returns a new instance of <code class="xref py py-class docutils literal notranslate"><span class="pre">ROIDataParam</span></code> with the fields set to the given values.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
 <dd class="field-odd"><ul class="simple">
-<li><p><strong>roidata</strong> (<a class="reference external" href="https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray" title="(in NumPy v2.0)"><em>numpy.ndarray</em></a>) – For convenience, this item accepts a 2d numpy array, a list of list of numbers, or none. In the end, the data is converted to a 2d numpy array of integers (if not none). Default: None.</p></li>
+<li><p><strong>roidata</strong> (<a class="reference external" href="https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray" title="(in NumPy v2.1)"><em>numpy.ndarray</em></a>) – For convenience, this item accepts a 2d numpy array, a list of list of numbers, or none. In the end, the data is converted to a 2d numpy array of integers (if not none). Default: None.</p></li>
 <li><p><strong>singleobj</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.12)"><em>bool</em></a>) – Whether to extract the roi as a single object or not. Default: None.</p></li>
 </ul>
 </dd>

en/.doctrees/intro/installation.doctree

@@ -566,7 +566,7 @@ <h2>How to develop a plugin?<a class="headerlink" href="#how-to-develop-a-plugin
 <p>This can be done:</p>
 <ul class="simple">
 <li><p>By installing DataLab in your Python environment (using one of the following methods:
-<a class="reference internal" href="../../intro/installation.html#install-pip"><span class="std std-ref">Package manager pip</span></a>, <a class="reference internal" href="../../intro/installation.html#install-wheel"><span class="std std-ref">Wheel package</span></a>, or <a class="reference internal" href="../../intro/installation.html#install-source"><span class="std std-ref">Source package</span></a>),</p></li>
+<a class="reference internal" href="../../intro/installation.html#install-conda"><span class="std std-ref">Conda package</span></a>, <a class="reference internal" href="../../intro/installation.html#install-pip"><span class="std std-ref">Package manager pip</span></a>, <a class="reference internal" href="../../intro/installation.html#install-wheel"><span class="std std-ref">Wheel package</span></a>, or <a class="reference internal" href="../../intro/installation.html#install-source"><span class="std std-ref">Source package</span></a>),</p></li>
 <li><p>Or by adding the <cite>cdl</cite> package to your Python path manually:</p>
 <ul>
 <li><p>Download the DataLab source code from the <a class="reference external" href="https://pypi.org/project/cdl/">PyPI page</a>,</p></li>

en/_images/i_beautiful.png

@@ -814,61 +814,61 @@ <h2>Windowing<a class="headerlink" href="#windowing" title="Link to this heading
 </thead>
 <tbody>
 <tr class="row-even"><td><p>Barthann</p></td>
-<td><p><a class="reference external" href="https://docs.scipy.org/doc/scipy/reference/generated/scipy.signal.windows.barthann.html#scipy.signal.windows.barthann" title="(in SciPy v1.14.0)"><code class="xref py py-func docutils literal notranslate"><span class="pre">scipy.signal.windows.barthann()</span></code></a></p></td>
+<td><p><a class="reference external" href="https://docs.scipy.org/doc/scipy/reference/generated/scipy.signal.windows.barthann.html#scipy.signal.windows.barthann" title="(in SciPy v1.14.1)"><code class="xref py py-func docutils literal notranslate"><span class="pre">scipy.signal.windows.barthann()</span></code></a></p></td>
 </tr>
 <tr class="row-odd"><td><p>Bartlett</p></td>
-<td><p><a class="reference external" href="https://numpy.org/doc/stable/reference/generated/numpy.bartlett.html#numpy.bartlett" title="(in NumPy v2.0)"><code class="xref py py-func docutils literal notranslate"><span class="pre">numpy.bartlett()</span></code></a></p></td>
+<td><p><a class="reference external" href="https://numpy.org/doc/stable/reference/generated/numpy.bartlett.html#numpy.bartlett" title="(in NumPy v2.1)"><code class="xref py py-func docutils literal notranslate"><span class="pre">numpy.bartlett()</span></code></a></p></td>
 </tr>
 <tr class="row-even"><td><p>Blackman</p></td>
-<td><p><a class="reference external" href="https://docs.scipy.org/doc/scipy/reference/generated/scipy.signal.windows.blackman.html#scipy.signal.windows.blackman" title="(in SciPy v1.14.0)"><code class="xref py py-func docutils literal notranslate"><span class="pre">scipy.signal.windows.blackman()</span></code></a></p></td>
+<td><p><a class="reference external" href="https://docs.scipy.org/doc/scipy/reference/generated/scipy.signal.windows.blackman.html#scipy.signal.windows.blackman" title="(in SciPy v1.14.1)"><code class="xref py py-func docutils literal notranslate"><span class="pre">scipy.signal.windows.blackman()</span></code></a></p></td>
 </tr>
 <tr class="row-odd"><td><p>Blackman-Harris</p></td>
-<td><p><a class="reference external" href="https://docs.scipy.org/doc/scipy/reference/generated/scipy.signal.windows.blackmanharris.html#scipy.signal.windows.blackmanharris" title="(in SciPy v1.14.0)"><code class="xref py py-func docutils literal notranslate"><span class="pre">scipy.signal.windows.blackmanharris()</span></code></a></p></td>
+<td><p><a class="reference external" href="https://docs.scipy.org/doc/scipy/reference/generated/scipy.signal.windows.blackmanharris.html#scipy.signal.windows.blackmanharris" title="(in SciPy v1.14.1)"><code class="xref py py-func docutils literal notranslate"><span class="pre">scipy.signal.windows.blackmanharris()</span></code></a></p></td>
 </tr>
 <tr class="row-even"><td><p>Bohman</p></td>
-<td><p><a class="reference external" href="https://docs.scipy.org/doc/scipy/reference/generated/scipy.signal.windows.bohman.html#scipy.signal.windows.bohman" title="(in SciPy v1.14.0)"><code class="xref py py-func docutils literal notranslate"><span class="pre">scipy.signal.windows.bohman()</span></code></a></p></td>
+<td><p><a class="reference external" href="https://docs.scipy.org/doc/scipy/reference/generated/scipy.signal.windows.bohman.html#scipy.signal.windows.bohman" title="(in SciPy v1.14.1)"><code class="xref py py-func docutils literal notranslate"><span class="pre">scipy.signal.windows.bohman()</span></code></a></p></td>
 </tr>
 <tr class="row-odd"><td><p>Boxcar</p></td>
-<td><p><a class="reference external" href="https://docs.scipy.org/doc/scipy/reference/generated/scipy.signal.windows.boxcar.html#scipy.signal.windows.boxcar" title="(in SciPy v1.14.0)"><code class="xref py py-func docutils literal notranslate"><span class="pre">scipy.signal.windows.boxcar()</span></code></a></p></td>
+<td><p><a class="reference external" href="https://docs.scipy.org/doc/scipy/reference/generated/scipy.signal.windows.boxcar.html#scipy.signal.windows.boxcar" title="(in SciPy v1.14.1)"><code class="xref py py-func docutils literal notranslate"><span class="pre">scipy.signal.windows.boxcar()</span></code></a></p></td>
 </tr>
 <tr class="row-even"><td><p>Cosine</p></td>
-<td><p><a class="reference external" href="https://docs.scipy.org/doc/scipy/reference/generated/scipy.signal.windows.cosine.html#scipy.signal.windows.cosine" title="(in SciPy v1.14.0)"><code class="xref py py-func docutils literal notranslate"><span class="pre">scipy.signal.windows.cosine()</span></code></a></p></td>
+<td><p><a class="reference external" href="https://docs.scipy.org/doc/scipy/reference/generated/scipy.signal.windows.cosine.html#scipy.signal.windows.cosine" title="(in SciPy v1.14.1)"><code class="xref py py-func docutils literal notranslate"><span class="pre">scipy.signal.windows.cosine()</span></code></a></p></td>
 </tr>
 <tr class="row-odd"><td><p>Exponential</p></td>
-<td><p><a class="reference external" href="https://docs.scipy.org/doc/scipy/reference/generated/scipy.signal.windows.exponential.html#scipy.signal.windows.exponential" title="(in SciPy v1.14.0)"><code class="xref py py-func docutils literal notranslate"><span class="pre">scipy.signal.windows.exponential()</span></code></a></p></td>
+<td><p><a class="reference external" href="https://docs.scipy.org/doc/scipy/reference/generated/scipy.signal.windows.exponential.html#scipy.signal.windows.exponential" title="(in SciPy v1.14.1)"><code class="xref py py-func docutils literal notranslate"><span class="pre">scipy.signal.windows.exponential()</span></code></a></p></td>
 </tr>
 <tr class="row-even"><td><p>Flat top</p></td>
-<td><p><a class="reference external" href="https://docs.scipy.org/doc/scipy/reference/generated/scipy.signal.windows.flattop.html#scipy.signal.windows.flattop" title="(in SciPy v1.14.0)"><code class="xref py py-func docutils literal notranslate"><span class="pre">scipy.signal.windows.flattop()</span></code></a></p></td>
+<td><p><a class="reference external" href="https://docs.scipy.org/doc/scipy/reference/generated/scipy.signal.windows.flattop.html#scipy.signal.windows.flattop" title="(in SciPy v1.14.1)"><code class="xref py py-func docutils literal notranslate"><span class="pre">scipy.signal.windows.flattop()</span></code></a></p></td>
 </tr>
 <tr class="row-odd"><td><p>Gaussian</p></td>
-<td><p><a class="reference external" href="https://docs.scipy.org/doc/scipy/reference/generated/scipy.signal.windows.gaussian.html#scipy.signal.windows.gaussian" title="(in SciPy v1.14.0)"><code class="xref py py-func docutils literal notranslate"><span class="pre">scipy.signal.windows.gaussian()</span></code></a></p></td>
+<td><p><a class="reference external" href="https://docs.scipy.org/doc/scipy/reference/generated/scipy.signal.windows.gaussian.html#scipy.signal.windows.gaussian" title="(in SciPy v1.14.1)"><code class="xref py py-func docutils literal notranslate"><span class="pre">scipy.signal.windows.gaussian()</span></code></a></p></td>
 </tr>
 <tr class="row-even"><td><p>Hamming</p></td>
-<td><p><a class="reference external" href="https://numpy.org/doc/stable/reference/generated/numpy.hamming.html#numpy.hamming" title="(in NumPy v2.0)"><code class="xref py py-func docutils literal notranslate"><span class="pre">numpy.hamming()</span></code></a></p></td>
+<td><p><a class="reference external" href="https://numpy.org/doc/stable/reference/generated/numpy.hamming.html#numpy.hamming" title="(in NumPy v2.1)"><code class="xref py py-func docutils literal notranslate"><span class="pre">numpy.hamming()</span></code></a></p></td>
 </tr>
 <tr class="row-odd"><td><p>Hanning</p></td>
-<td><p><a class="reference external" href="https://numpy.org/doc/stable/reference/generated/numpy.hanning.html#numpy.hanning" title="(in NumPy v2.0)"><code class="xref py py-func docutils literal notranslate"><span class="pre">numpy.hanning()</span></code></a></p></td>
+<td><p><a class="reference external" href="https://numpy.org/doc/stable/reference/generated/numpy.hanning.html#numpy.hanning" title="(in NumPy v2.1)"><code class="xref py py-func docutils literal notranslate"><span class="pre">numpy.hanning()</span></code></a></p></td>
 </tr>
 <tr class="row-even"><td><p>Kaiser</p></td>
-<td><p><a class="reference external" href="https://docs.scipy.org/doc/scipy/reference/generated/scipy.signal.windows.kaiser.html#scipy.signal.windows.kaiser" title="(in SciPy v1.14.0)"><code class="xref py py-func docutils literal notranslate"><span class="pre">scipy.signal.windows.kaiser()</span></code></a></p></td>
+<td><p><a class="reference external" href="https://docs.scipy.org/doc/scipy/reference/generated/scipy.signal.windows.kaiser.html#scipy.signal.windows.kaiser" title="(in SciPy v1.14.1)"><code class="xref py py-func docutils literal notranslate"><span class="pre">scipy.signal.windows.kaiser()</span></code></a></p></td>
 </tr>
 <tr class="row-odd"><td><p>Lanczos</p></td>
-<td><p><a class="reference external" href="https://docs.scipy.org/doc/scipy/reference/generated/scipy.signal.windows.lanczos.html#scipy.signal.windows.lanczos" title="(in SciPy v1.14.0)"><code class="xref py py-func docutils literal notranslate"><span class="pre">scipy.signal.windows.lanczos()</span></code></a></p></td>
+<td><p><a class="reference external" href="https://docs.scipy.org/doc/scipy/reference/generated/scipy.signal.windows.lanczos.html#scipy.signal.windows.lanczos" title="(in SciPy v1.14.1)"><code class="xref py py-func docutils literal notranslate"><span class="pre">scipy.signal.windows.lanczos()</span></code></a></p></td>
 </tr>
 <tr class="row-even"><td><p>Nuttall</p></td>
-<td><p><a class="reference external" href="https://docs.scipy.org/doc/scipy/reference/generated/scipy.signal.windows.nuttall.html#scipy.signal.windows.nuttall" title="(in SciPy v1.14.0)"><code class="xref py py-func docutils literal notranslate"><span class="pre">scipy.signal.windows.nuttall()</span></code></a></p></td>
+<td><p><a class="reference external" href="https://docs.scipy.org/doc/scipy/reference/generated/scipy.signal.windows.nuttall.html#scipy.signal.windows.nuttall" title="(in SciPy v1.14.1)"><code class="xref py py-func docutils literal notranslate"><span class="pre">scipy.signal.windows.nuttall()</span></code></a></p></td>
 </tr>
 <tr class="row-odd"><td><p>Parzen</p></td>
-<td><p><a class="reference external" href="https://docs.scipy.org/doc/scipy/reference/generated/scipy.signal.windows.parzen.html#scipy.signal.windows.parzen" title="(in SciPy v1.14.0)"><code class="xref py py-func docutils literal notranslate"><span class="pre">scipy.signal.windows.parzen()</span></code></a></p></td>
+<td><p><a class="reference external" href="https://docs.scipy.org/doc/scipy/reference/generated/scipy.signal.windows.parzen.html#scipy.signal.windows.parzen" title="(in SciPy v1.14.1)"><code class="xref py py-func docutils literal notranslate"><span class="pre">scipy.signal.windows.parzen()</span></code></a></p></td>
 </tr>
 <tr class="row-even"><td><p>Rectangular</p></td>
-<td><p><a class="reference external" href="https://numpy.org/doc/stable/reference/generated/numpy.ones.html#numpy.ones" title="(in NumPy v2.0)"><code class="xref py py-func docutils literal notranslate"><span class="pre">numpy.ones()</span></code></a></p></td>
+<td><p><a class="reference external" href="https://numpy.org/doc/stable/reference/generated/numpy.ones.html#numpy.ones" title="(in NumPy v2.1)"><code class="xref py py-func docutils literal notranslate"><span class="pre">numpy.ones()</span></code></a></p></td>
 </tr>
 <tr class="row-odd"><td><p>Taylor</p></td>
-<td><p><a class="reference external" href="https://docs.scipy.org/doc/scipy/reference/generated/scipy.signal.windows.taylor.html#scipy.signal.windows.taylor" title="(in SciPy v1.14.0)"><code class="xref py py-func docutils literal notranslate"><span class="pre">scipy.signal.windows.taylor()</span></code></a></p></td>
+<td><p><a class="reference external" href="https://docs.scipy.org/doc/scipy/reference/generated/scipy.signal.windows.taylor.html#scipy.signal.windows.taylor" title="(in SciPy v1.14.1)"><code class="xref py py-func docutils literal notranslate"><span class="pre">scipy.signal.windows.taylor()</span></code></a></p></td>
 </tr>
 <tr class="row-even"><td><p>Tukey</p></td>
-<td><p><a class="reference external" href="https://docs.scipy.org/doc/scipy/reference/generated/scipy.signal.windows.tukey.html#scipy.signal.windows.tukey" title="(in SciPy v1.14.0)"><code class="xref py py-func docutils literal notranslate"><span class="pre">scipy.signal.windows.tukey()</span></code></a></p></td>
+<td><p><a class="reference external" href="https://docs.scipy.org/doc/scipy/reference/generated/scipy.signal.windows.tukey.html#scipy.signal.windows.tukey" title="(in SciPy v1.14.1)"><code class="xref py py-func docutils literal notranslate"><span class="pre">scipy.signal.windows.tukey()</span></code></a></p></td>
 </tr>
 </tbody>
 </table>