[master] Closes #34 (Removed slashes in TimeSeries method definitions…

…, and simplified the variable names, e.g., event_name --> name)

doc/_build/html/api/kineticstoolkit.TimeSeries.fill_missing_samples.html

@@ -282,14 +282,11 @@ <h1>kineticstoolkit.TimeSeries.fill_missing_samples<a class="headerlink" href="#
 <dt class="sig sig-object py" id="kineticstoolkit.TimeSeries.fill_missing_samples">
 <span class="sig-prename descclassname"><span class="pre">TimeSeries.</span></span><span class="sig-name descname"><span class="pre">fill_missing_samples</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">max_missing_samples</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">method</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'linear'</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#kineticstoolkit.TimeSeries.fill_missing_samples" title="Permalink to this definition">¶</a></dt>
 <dd><p>Fill missing samples with the given method.</p>
-<div class="admonition note">
-<p class="admonition-title">Note</p>
 <p>The sample rate must be constant.</p>
-</div>
 <div class="admonition warning">
 <p class="admonition-title">Warning</p>
-<p>This function, which has been introduced in 0.1, is still experimental and
-may change signature or behaviour in the future.</p>
+<p>This function, which has been introduced in 0.1, is still experimental
+and may change signature or behaviour in the future.</p>
 </div>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters</dt>

doc/_build/html/api/kineticstoolkit.TimeSeries.from_dataframe.html

@@ -281,7 +281,7 @@ <h1>kineticstoolkit.TimeSeries.from_dataframe<a class="headerlink" href="#kineti
 <dl class="py method">
 <dt class="sig sig-object py" id="kineticstoolkit.TimeSeries.from_dataframe">
 <span class="sig-prename descclassname"><span class="pre">TimeSeries.</span></span><span class="sig-name descname"><span class="pre">from_dataframe</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#kineticstoolkit.TimeSeries.from_dataframe" title="Permalink to this definition">¶</a></dt>
-<dd><p>Create a new TimeSeries from a Pandas Dataframe</p>
+<dd><p>Create a new TimeSeries from a Pandas Dataframe.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters</dt>
 <dd class="field-odd"><p><strong>dataframe</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">DataFrame</span></code>) – A Pandas DataFrame where the index corresponds to time, and

doc/_build/html/api/kineticstoolkit.TimeSeries.get_event_index.html

@@ -280,13 +280,13 @@
 <h1>kineticstoolkit.TimeSeries.get_event_index<a class="headerlink" href="#kineticstoolkit-timeseries-get-event-index" title="Permalink to this headline">¶</a></h1>
 <dl class="py method">
 <dt class="sig sig-object py" id="kineticstoolkit.TimeSeries.get_event_index">
-<span class="sig-prename descclassname"><span class="pre">TimeSeries.</span></span><span class="sig-name descname"><span class="pre">get_event_index</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">event_name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">event_occurrence</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#kineticstoolkit.TimeSeries.get_event_index" title="Permalink to this definition">¶</a></dt>
+<span class="sig-prename descclassname"><span class="pre">TimeSeries.</span></span><span class="sig-name descname"><span class="pre">get_event_index</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">occurrence</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#kineticstoolkit.TimeSeries.get_event_index" title="Permalink to this definition">¶</a></dt>
 <dd><p>Get the index of a given occurrence of an event name.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters</dt>
 <dd class="field-odd"><ul class="simple">
-<li><p><strong>event_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Name of the event to look for in the events list.</p></li>
-<li><p><strong>event_occurrence</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code>) – i_th occurence of the event to look for in the events
+<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Name of the event to look for in the events list.</p></li>
+<li><p><strong>occurrence</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code>) – i_th occurence of the event to look for in the events
 list, starting at 0, where the occurrences are sorted in time.</p></li>
 </ul>
 </dd>

doc/_build/html/api/kineticstoolkit.TimeSeries.get_event_time.html

@@ -280,13 +280,13 @@
 <h1>kineticstoolkit.TimeSeries.get_event_time<a class="headerlink" href="#kineticstoolkit-timeseries-get-event-time" title="Permalink to this headline">¶</a></h1>
 <dl class="py method">
 <dt class="sig sig-object py" id="kineticstoolkit.TimeSeries.get_event_time">
-<span class="sig-prename descclassname"><span class="pre">TimeSeries.</span></span><span class="sig-name descname"><span class="pre">get_event_time</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">event_name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">event_occurrence</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">/</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#kineticstoolkit.TimeSeries.get_event_time" title="Permalink to this definition">¶</a></dt>
+<span class="sig-prename descclassname"><span class="pre">TimeSeries.</span></span><span class="sig-name descname"><span class="pre">get_event_time</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">occurrence</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#kineticstoolkit.TimeSeries.get_event_time" title="Permalink to this definition">¶</a></dt>
 <dd><p>Get the time of the specified event.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters</dt>
 <dd class="field-odd"><ul class="simple">
-<li><p><strong>event_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Name of the event to look for in the events list.</p></li>
-<li><p><strong>event_occurrence</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code>) – Optional. i_th occurence of the event to look for in the events
+<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Name of the event to look for in the events list.</p></li>
+<li><p><strong>occurrence</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code>) – Optional. i_th occurence of the event to look for in the events
 list, starting at 0.</p></li>
 </ul>
 </dd>

doc/_build/html/api/kineticstoolkit.TimeSeries.get_index_after_time.html

@@ -280,7 +280,7 @@
 <h1>kineticstoolkit.TimeSeries.get_index_after_time<a class="headerlink" href="#kineticstoolkit-timeseries-get-index-after-time" title="Permalink to this headline">¶</a></h1>
 <dl class="py method">
 <dt class="sig sig-object py" id="kineticstoolkit.TimeSeries.get_index_after_time">
-<span class="sig-prename descclassname"><span class="pre">TimeSeries.</span></span><span class="sig-name descname"><span class="pre">get_index_after_time</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">time</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">/</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">inclusive</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#kineticstoolkit.TimeSeries.get_index_after_time" title="Permalink to this definition">¶</a></dt>
+<span class="sig-prename descclassname"><span class="pre">TimeSeries.</span></span><span class="sig-name descname"><span class="pre">get_index_after_time</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">time</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">inclusive</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#kineticstoolkit.TimeSeries.get_index_after_time" title="Permalink to this definition">¶</a></dt>
 <dd><p>Get the time index that is just after the specified time.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters</dt>

doc/_build/html/api/kineticstoolkit.TimeSeries.get_index_at_time.html

@@ -280,7 +280,7 @@
 <h1>kineticstoolkit.TimeSeries.get_index_at_time<a class="headerlink" href="#kineticstoolkit-timeseries-get-index-at-time" title="Permalink to this headline">¶</a></h1>
 <dl class="py method">
 <dt class="sig sig-object py" id="kineticstoolkit.TimeSeries.get_index_at_time">
-<span class="sig-prename descclassname"><span class="pre">TimeSeries.</span></span><span class="sig-name descname"><span class="pre">get_index_at_time</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">time</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">/</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#kineticstoolkit.TimeSeries.get_index_at_time" title="Permalink to this definition">¶</a></dt>
+<span class="sig-prename descclassname"><span class="pre">TimeSeries.</span></span><span class="sig-name descname"><span class="pre">get_index_at_time</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">time</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#kineticstoolkit.TimeSeries.get_index_at_time" title="Permalink to this definition">¶</a></dt>
 <dd><p>Get the time index that is the closest to the specified time.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters</dt>

doc/_build/html/api/kineticstoolkit.TimeSeries.get_index_before_time.html

@@ -280,7 +280,7 @@
 <h1>kineticstoolkit.TimeSeries.get_index_before_time<a class="headerlink" href="#kineticstoolkit-timeseries-get-index-before-time" title="Permalink to this headline">¶</a></h1>
 <dl class="py method">
 <dt class="sig sig-object py" id="kineticstoolkit.TimeSeries.get_index_before_time">
-<span class="sig-prename descclassname"><span class="pre">TimeSeries.</span></span><span class="sig-name descname"><span class="pre">get_index_before_time</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">time</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">/</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">inclusive</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#kineticstoolkit.TimeSeries.get_index_before_time" title="Permalink to this definition">¶</a></dt>
+<span class="sig-prename descclassname"><span class="pre">TimeSeries.</span></span><span class="sig-name descname"><span class="pre">get_index_before_time</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">time</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">inclusive</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#kineticstoolkit.TimeSeries.get_index_before_time" title="Permalink to this definition">¶</a></dt>
 <dd><p>Get the time index that is just before the specified time.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters</dt>

doc/_build/html/api/kineticstoolkit.TimeSeries.get_ts_after_event.html

@@ -280,13 +280,13 @@
 <h1>kineticstoolkit.TimeSeries.get_ts_after_event<a class="headerlink" href="#kineticstoolkit-timeseries-get-ts-after-event" title="Permalink to this headline">¶</a></h1>
 <dl class="py method">
 <dt class="sig sig-object py" id="kineticstoolkit.TimeSeries.get_ts_after_event">
-<span class="sig-prename descclassname"><span class="pre">TimeSeries.</span></span><span class="sig-name descname"><span class="pre">get_ts_after_event</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">event_name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">event_occurrence</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">/</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">inclusive</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#kineticstoolkit.TimeSeries.get_ts_after_event" title="Permalink to this definition">¶</a></dt>
+<span class="sig-prename descclassname"><span class="pre">TimeSeries.</span></span><span class="sig-name descname"><span class="pre">get_ts_after_event</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">occurrence</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">inclusive</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#kineticstoolkit.TimeSeries.get_ts_after_event" title="Permalink to this definition">¶</a></dt>
 <dd><p>Get a subset of the TimeSeries after the specified event.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters</dt>
 <dd class="field-odd"><ul class="simple">
-<li><p><strong>event_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Name of the event to look for in the events list.</p></li>
-<li><p><strong>event_occurrence</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code>) – Optional. i_th occurence of the event to look for in the events
+<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Name of the event to look for in the events list.</p></li>
+<li><p><strong>occurrence</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code>) – Optional. i_th occurence of the event to look for in the events
 list, starting at 0.</p></li>
 <li><p><strong>inclusive</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – Optional. True to include the given event in the comparison.</p></li>
 </ul>

doc/_build/html/api/kineticstoolkit.TimeSeries.get_ts_after_index.html

@@ -280,7 +280,7 @@
 <h1>kineticstoolkit.TimeSeries.get_ts_after_index<a class="headerlink" href="#kineticstoolkit-timeseries-get-ts-after-index" title="Permalink to this headline">¶</a></h1>
 <dl class="py method">
 <dt class="sig sig-object py" id="kineticstoolkit.TimeSeries.get_ts_after_index">
-<span class="sig-prename descclassname"><span class="pre">TimeSeries.</span></span><span class="sig-name descname"><span class="pre">get_ts_after_index</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">index</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">/</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">inclusive</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#kineticstoolkit.TimeSeries.get_ts_after_index" title="Permalink to this definition">¶</a></dt>
+<span class="sig-prename descclassname"><span class="pre">TimeSeries.</span></span><span class="sig-name descname"><span class="pre">get_ts_after_index</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">index</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">inclusive</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#kineticstoolkit.TimeSeries.get_ts_after_index" title="Permalink to this definition">¶</a></dt>
 <dd><p>Get a subset of the TimeSeries after the specified time index.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters</dt>

doc/_build/html/api/kineticstoolkit.TimeSeries.get_ts_after_time.html

@@ -280,7 +280,7 @@
 <h1>kineticstoolkit.TimeSeries.get_ts_after_time<a class="headerlink" href="#kineticstoolkit-timeseries-get-ts-after-time" title="Permalink to this headline">¶</a></h1>
 <dl class="py method">
 <dt class="sig sig-object py" id="kineticstoolkit.TimeSeries.get_ts_after_time">
-<span class="sig-prename descclassname"><span class="pre">TimeSeries.</span></span><span class="sig-name descname"><span class="pre">get_ts_after_time</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">time</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">/</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">inclusive</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#kineticstoolkit.TimeSeries.get_ts_after_time" title="Permalink to this definition">¶</a></dt>
+<span class="sig-prename descclassname"><span class="pre">TimeSeries.</span></span><span class="sig-name descname"><span class="pre">get_ts_after_time</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">time</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">inclusive</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#kineticstoolkit.TimeSeries.get_ts_after_time" title="Permalink to this definition">¶</a></dt>
 <dd><p>Get a subset of the TimeSeries after the specified time.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters</dt>