Skip to content

Commit 7c7f3ac

Browse files
1 parent a0cf972 commit 7c7f3ac

16 files changed

Lines changed: 238 additions & 73 deletions
2.7 KB
Binary file not shown.
4.79 KB
Binary file not shown.
4 Bytes
Binary file not shown.

.doctrees/environment.pickle

6.12 KB
Binary file not shown.

_autosummary/suboptimumg.compsim.custom_run.html

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -437,7 +437,7 @@
437437
</dl>
438438
<dl class="py method">
439439
<dt class="sig sig-object py" id="suboptimumg.compsim.custom_run.CustomRun.comparison_track_overlays">
440-
<span class="sig-name descname"><span class="pre">comparison_track_overlays</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">sim_var</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">data_var</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">lat</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">long</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">use_coast</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">rotate_by_deg</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0.0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">show_matching_info</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">font_config</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">layout_config</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">colorbar_config</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/suboptimumg/compsim/custom_run.html#CustomRun.comparison_track_overlays"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#suboptimumg.compsim.custom_run.CustomRun.comparison_track_overlays" title="Link to this definition">#</a></dt>
440+
<span class="sig-name descname"><span class="pre">comparison_track_overlays</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">sim_var</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">data_var</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">lat</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">long</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">use_coast</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">rotate_by_deg</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0.0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">show_matching_info</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">display_raw_data</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">interpolate_gaps</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">font_config</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">layout_config</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">colorbar_config</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/suboptimumg/compsim/custom_run.html#CustomRun.comparison_track_overlays"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#suboptimumg.compsim.custom_run.CustomRun.comparison_track_overlays" title="Link to this definition">#</a></dt>
441441
<dd><p>Overlay plot comparing simulation results to real-world data on the track layout.</p>
442442
<dl class="field-list simple">
443443
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
@@ -449,9 +449,11 @@
449449
<li><p><strong>use_coast</strong> (<em>bool</em><em>, </em><em>optional</em>) – Whether to use coasting results from the simulation. Default is True</p></li>
450450
<li><p><strong>rotate_by_deg</strong> (<em>float</em><em>, </em><em>optional</em>) – Degrees to rotate the track plot for better visualization. Default is 0.0</p></li>
451451
<li><p><strong>show_matching_info</strong> (<em>bool</em><em>, </em><em>optional</em>) – If True, print matching information during GPS to track matching. Default is False</p></li>
452+
<li><p><strong>display_raw_data</strong> (<em>bool</em><em>, </em><em>optional</em>) – If True, plot the projected GPS data rather than the difference. Default is False</p></li>
452453
<li><p><strong>font_config</strong> (<a class="reference internal" href="suboptimumg.plotting.plotting_constants.html#suboptimumg.plotting.plotting_constants.FontConfig" title="suboptimumg.plotting.plotting_constants.FontConfig"><em>FontConfig</em></a><em> | </em><em>None</em><em>, </em><em>optional</em>)</p></li>
453454
<li><p><strong>layout_config</strong> (<a class="reference internal" href="suboptimumg.plotting.plotting_constants.html#suboptimumg.plotting.plotting_constants.LayoutConfig" title="suboptimumg.plotting.plotting_constants.LayoutConfig"><em>LayoutConfig</em></a><em> | </em><em>None</em><em>, </em><em>optional</em>)</p></li>
454455
<li><p><strong>colorbar_config</strong> (<a class="reference internal" href="suboptimumg.plotting.plotting_constants.html#suboptimumg.plotting.plotting_constants.ColorbarConfig" title="suboptimumg.plotting.plotting_constants.ColorbarConfig"><em>ColorbarConfig</em></a><em> | </em><em>None</em><em>, </em><em>optional</em>)</p></li>
456+
<li><p><strong>interpolate_gaps</strong> (<em>bool</em>)</p></li>
455457
</ul>
456458
</dd>
457459
<dt class="field-even">Return type<span class="colon">:</span></dt>

_autosummary/suboptimumg.compsim.models.html

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -753,6 +753,7 @@
753753
<li><p><a class="reference internal" href="#suboptimumg.compsim.models.InternalData.initial_velocity" title="suboptimumg.compsim.models.InternalData.initial_velocity"><code class="xref py py-obj docutils literal notranslate"><span class="pre">initial_velocity</span> <span class="pre">(float)</span></code></a></p></li>
754754
<li><p><a class="reference internal" href="#suboptimumg.compsim.models.InternalData.per_seed" title="suboptimumg.compsim.models.InternalData.per_seed"><code class="xref py py-obj docutils literal notranslate"><span class="pre">per_seed</span> <span class="pre">(List[suboptimumg.compsim.models.InternalDataSeedInfo])</span></code></a></p></li>
755755
<li><p><a class="reference internal" href="#suboptimumg.compsim.models.InternalData.seed_idx_list" title="suboptimumg.compsim.models.InternalData.seed_idx_list"><code class="xref py py-obj docutils literal notranslate"><span class="pre">seed_idx_list</span> <span class="pre">(numpy.ndarray[tuple[Any,</span> <span class="pre">...],</span> <span class="pre">numpy.dtype[numpy.integer]])</span></code></a></p></li>
756+
<li><p><a class="reference internal" href="#suboptimumg.compsim.models.InternalData.seed_v_list" title="suboptimumg.compsim.models.InternalData.seed_v_list"><code class="xref py py-obj docutils literal notranslate"><span class="pre">seed_v_list</span> <span class="pre">(numpy.ndarray[tuple[Any,</span> <span class="pre">...],</span> <span class="pre">numpy.dtype[numpy.float64]])</span></code></a></p></li>
756757
<li><p><a class="reference internal" href="#suboptimumg.compsim.models.InternalData.v_max_profile" title="suboptimumg.compsim.models.InternalData.v_max_profile"><code class="xref py py-obj docutils literal notranslate"><span class="pre">v_max_profile</span> <span class="pre">(numpy.ndarray[tuple[Any,</span> <span class="pre">...],</span> <span class="pre">numpy.dtype[numpy.float64]])</span></code></a></p></li>
757758
</ul>
758759
</dd>
@@ -781,6 +782,12 @@
781782
<dd><p>Cumulative distance along the track (m)</p>
782783
</dd></dl>
783784

785+
<dl class="py attribute pydantic_field">
786+
<dt class="sig sig-object py" id="suboptimumg.compsim.models.InternalData.seed_v_list">
787+
<em class="property"><span class="pre">field</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">seed_v_list</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><code class="xref py py-class docutils literal notranslate"><span class="pre">ndarray</span></code><span class="pre">[</span><code class="xref py py-class docutils literal notranslate"><span class="pre">tuple</span></code><span class="pre">[</span><code class="xref py py-data docutils literal notranslate"><span class="pre">Any</span></code><span class="pre">,</span> <code class="xref py py-data docutils literal notranslate"><span class="pre">...</span></code><span class="pre">],</span> <code class="xref py py-class docutils literal notranslate"><span class="pre">dtype</span></code><span class="pre">[</span><code class="xref py py-class docutils literal notranslate"><span class="pre">float64</span></code><span class="pre">]]</span></em><em class="property"> <span class="pre">[Required]</span></em><a class="headerlink" href="#suboptimumg.compsim.models.InternalData.seed_v_list" title="Link to this definition">#</a></dt>
788+
<dd><p>List of seed velocities, corresponding to seed_idx_list</p>
789+
</dd></dl>
790+
784791
<dl class="py attribute pydantic_field">
785792
<dt class="sig sig-object py" id="suboptimumg.compsim.models.InternalData.per_seed">
786793
<em class="property"><span class="pre">field</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">per_seed</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code><span class="pre">[</span><a class="reference internal" href="#suboptimumg.compsim.models.InternalDataSeedInfo" title="suboptimumg.compsim.models.InternalDataSeedInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">InternalDataSeedInfo</span></code></a><span class="pre">]</span></em><em class="property"> <span class="pre">[Required]</span></em><a class="headerlink" href="#suboptimumg.compsim.models.InternalData.per_seed" title="Link to this definition">#</a></dt>
@@ -1019,6 +1026,7 @@
10191026
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#suboptimumg.compsim.models.InternalData.v_max_profile"><code class="docutils literal notranslate"><span class="pre">InternalData.v_max_profile</span></code></a></li>
10201027
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#suboptimumg.compsim.models.InternalData.seed_idx_list"><code class="docutils literal notranslate"><span class="pre">InternalData.seed_idx_list</span></code></a></li>
10211028
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#suboptimumg.compsim.models.InternalData.cumulative_dist"><code class="docutils literal notranslate"><span class="pre">InternalData.cumulative_dist</span></code></a></li>
1029+
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#suboptimumg.compsim.models.InternalData.seed_v_list"><code class="docutils literal notranslate"><span class="pre">InternalData.seed_v_list</span></code></a></li>
10221030
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#suboptimumg.compsim.models.InternalData.per_seed"><code class="docutils literal notranslate"><span class="pre">InternalData.per_seed</span></code></a></li>
10231031
</ul>
10241032
</li>

_autosummary/suboptimumg.track.models.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -628,7 +628,7 @@
628628

629629
<dl class="py attribute pydantic_field">
630630
<dt class="sig sig-object py" id="suboptimumg.track.models.CoordinateListInput.smoothing">
631-
<em class="property"><span class="pre">field</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">smoothing</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><code class="xref py py-class docutils literal notranslate"><span class="pre">float</span></code></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">0.0</span></em><a class="headerlink" href="#suboptimumg.track.models.CoordinateListInput.smoothing" title="Link to this definition">#</a></dt>
631+
<em class="property"><span class="pre">field</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">smoothing</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><code class="xref py py-class docutils literal notranslate"><span class="pre">float</span></code></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">6e-07</span></em><a class="headerlink" href="#suboptimumg.track.models.CoordinateListInput.smoothing" title="Link to this definition">#</a></dt>
632632
<dd><p>Smoothing parameter for spline interpolation</p>
633633
</dd></dl>
634634

0 commit comments

Comments
 (0)