Skip to content

Commit 8fe1e51

Browse files
C4dynamicsC4dynamics
authored
Merge pull request #118 from C4dynamics/dev
Add a tutorial section to docs
2 parents d700d00 + f7721de commit 8fe1e51

File tree

143 files changed

+5899
-715
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

143 files changed

+5899
-715
lines changed

‎docs/_modules/c4dynamics/datasets/_manager.html‎

Lines changed: 21 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@
3737
<link rel="preload" as="script" href="../../../_static/scripts/pydata-sphinx-theme.js?digest=dfe6caa3a7d634c4db9b" />
3838
<script src="../../../_static/vendor/fontawesome/6.5.2/js/all.min.js?digest=dfe6caa3a7d634c4db9b"></script>
3939

40-
<script src="../../../_static/documentation_options.js?v=10261ce1"></script>
40+
<script src="../../../_static/documentation_options.js?v=bcae1e9a"></script>
4141
<script src="../../../_static/doctools.js?v=9bcbadda"></script>
4242
<script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
4343
<script src="../../../_static/scripts/sphinx-book-theme.js?v=887ef09a"></script>
@@ -49,7 +49,7 @@
4949
<link rel="search" title="Search" href="../../../search.html" />
5050
<meta name="viewport" content="width=device-width, initial-scale=1"/>
5151
<meta name="docsearch:language" content="en"/>
52-
<meta name="docbuild:last-update" content="Dec 01, 2025"/>
52+
<meta name="docbuild:last-update" content="Dec 17, 2025"/>
5353
</head>
5454

5555

@@ -174,14 +174,30 @@
174174
<li class="toctree-l1"><a class="reference internal" href="../../../concepts/sensors.html">Sensors</a></li>
175175
<li class="toctree-l1"><a class="reference internal" href="../../../concepts/filters.html">Filters</a></li>
176176
<li class="toctree-l1"><a class="reference internal" href="../../../concepts/rl_env.html">Reinforcement Learning Enviroenment</a></li>
177+
</ul>
178+
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Toturials</span></p>
179+
<ul class="nav bd-sidenav">
180+
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/setup_guide.html">Setup Guide</a></li>
181+
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/introduction_guide.html">Interactive Introduction to State Space and State Objects Modeling</a></li>
182+
183+
184+
185+
186+
187+
188+
189+
190+
191+
192+
177193
</ul>
178194
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Use Cases</span></p>
179195
<ul class="nav bd-sidenav">
180-
<li class="toctree-l1"><a class="reference internal" href="../../../programs/dof6sim.html">Proportional Navigation Guidance - 6 Degrees of Freedom</a></li>
196+
<li class="toctree-l1"><a class="reference internal" href="../../../programs/dof6sim.html">Proportional Navigation Guidance - 6 Degrees of Freedom Simulation</a></li>
181197
<li class="toctree-l1"><a class="reference internal" href="../../../programs/ballistic_coefficient.html">Ballistic Coefficient Estimation - Extended Kalman Filter</a></li>
182198

183199

184-
<li class="toctree-l1"><a class="reference internal" href="../../../programs/car_tracker.html">Car Tracker - Objects Detection and Kalman Filter</a></li>
200+
<li class="toctree-l1"><a class="reference internal" href="../../../programs/car_tracker.html">Cars Tracker – Kalman Filter and Objects Detection Model</a></li>
185201
</ul>
186202
<p aria-level="2" class="caption" role="heading"><span class="caption-text">API</span></p>
187203
<ul class="nav bd-sidenav">
@@ -1073,7 +1089,7 @@ <h1>Source code for c4dynamics.datasets._manager</h1><div class="highlight"><pre
10731089

10741090
<div class="footer-item">
10751091
<p class="last-updated">
1076-
Last updated on Dec 01, 2025.
1092+
Last updated on Dec 17, 2025.
10771093
<br/>
10781094
</p>
10791095
</div>

‎docs/_modules/c4dynamics/detectors/yolo3_opencv.html‎

Lines changed: 21 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@
3737
<link rel="preload" as="script" href="../../../_static/scripts/pydata-sphinx-theme.js?digest=dfe6caa3a7d634c4db9b" />
3838
<script src="../../../_static/vendor/fontawesome/6.5.2/js/all.min.js?digest=dfe6caa3a7d634c4db9b"></script>
3939

40-
<script src="../../../_static/documentation_options.js?v=10261ce1"></script>
40+
<script src="../../../_static/documentation_options.js?v=bcae1e9a"></script>
4141
<script src="../../../_static/doctools.js?v=9bcbadda"></script>
4242
<script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
4343
<script src="../../../_static/scripts/sphinx-book-theme.js?v=887ef09a"></script>
@@ -49,7 +49,7 @@
4949
<link rel="search" title="Search" href="../../../search.html" />
5050
<meta name="viewport" content="width=device-width, initial-scale=1"/>
5151
<meta name="docsearch:language" content="en"/>
52-
<meta name="docbuild:last-update" content="Dec 01, 2025"/>
52+
<meta name="docbuild:last-update" content="Dec 17, 2025"/>
5353
</head>
5454

5555

@@ -174,14 +174,30 @@
174174
<li class="toctree-l1"><a class="reference internal" href="../../../concepts/sensors.html">Sensors</a></li>
175175
<li class="toctree-l1"><a class="reference internal" href="../../../concepts/filters.html">Filters</a></li>
176176
<li class="toctree-l1"><a class="reference internal" href="../../../concepts/rl_env.html">Reinforcement Learning Enviroenment</a></li>
177+
</ul>
178+
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Toturials</span></p>
179+
<ul class="nav bd-sidenav">
180+
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/setup_guide.html">Setup Guide</a></li>
181+
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/introduction_guide.html">Interactive Introduction to State Space and State Objects Modeling</a></li>
182+
183+
184+
185+
186+
187+
188+
189+
190+
191+
192+
177193
</ul>
178194
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Use Cases</span></p>
179195
<ul class="nav bd-sidenav">
180-
<li class="toctree-l1"><a class="reference internal" href="../../../programs/dof6sim.html">Proportional Navigation Guidance - 6 Degrees of Freedom</a></li>
196+
<li class="toctree-l1"><a class="reference internal" href="../../../programs/dof6sim.html">Proportional Navigation Guidance - 6 Degrees of Freedom Simulation</a></li>
181197
<li class="toctree-l1"><a class="reference internal" href="../../../programs/ballistic_coefficient.html">Ballistic Coefficient Estimation - Extended Kalman Filter</a></li>
182198

183199

184-
<li class="toctree-l1"><a class="reference internal" href="../../../programs/car_tracker.html">Car Tracker - Objects Detection and Kalman Filter</a></li>
200+
<li class="toctree-l1"><a class="reference internal" href="../../../programs/car_tracker.html">Cars Tracker – Kalman Filter and Objects Detection Model</a></li>
185201
</ul>
186202
<p aria-level="2" class="caption" role="heading"><span class="caption-text">API</span></p>
187203
<ul class="nav bd-sidenav">
@@ -1112,7 +1128,7 @@ <h1>Source code for c4dynamics.detectors.yolo3_opencv</h1><div class="highlight"
11121128

11131129
<div class="footer-item">
11141130
<p class="last-updated">
1115-
Last updated on Dec 01, 2025.
1131+
Last updated on Dec 17, 2025.
11161132
<br/>
11171133
</p>
11181134
</div>

‎docs/_modules/c4dynamics/eqm/derivs.html‎

Lines changed: 21 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@
3737
<link rel="preload" as="script" href="../../../_static/scripts/pydata-sphinx-theme.js?digest=dfe6caa3a7d634c4db9b" />
3838
<script src="../../../_static/vendor/fontawesome/6.5.2/js/all.min.js?digest=dfe6caa3a7d634c4db9b"></script>
3939

40-
<script src="../../../_static/documentation_options.js?v=10261ce1"></script>
40+
<script src="../../../_static/documentation_options.js?v=bcae1e9a"></script>
4141
<script src="../../../_static/doctools.js?v=9bcbadda"></script>
4242
<script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
4343
<script src="../../../_static/scripts/sphinx-book-theme.js?v=887ef09a"></script>
@@ -49,7 +49,7 @@
4949
<link rel="search" title="Search" href="../../../search.html" />
5050
<meta name="viewport" content="width=device-width, initial-scale=1"/>
5151
<meta name="docsearch:language" content="en"/>
52-
<meta name="docbuild:last-update" content="Dec 01, 2025"/>
52+
<meta name="docbuild:last-update" content="Dec 17, 2025"/>
5353
</head>
5454

5555

@@ -174,14 +174,30 @@
174174
<li class="toctree-l1"><a class="reference internal" href="../../../concepts/sensors.html">Sensors</a></li>
175175
<li class="toctree-l1"><a class="reference internal" href="../../../concepts/filters.html">Filters</a></li>
176176
<li class="toctree-l1"><a class="reference internal" href="../../../concepts/rl_env.html">Reinforcement Learning Enviroenment</a></li>
177+
</ul>
178+
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Toturials</span></p>
179+
<ul class="nav bd-sidenav">
180+
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/setup_guide.html">Setup Guide</a></li>
181+
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/introduction_guide.html">Interactive Introduction to State Space and State Objects Modeling</a></li>
182+
183+
184+
185+
186+
187+
188+
189+
190+
191+
192+
177193
</ul>
178194
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Use Cases</span></p>
179195
<ul class="nav bd-sidenav">
180-
<li class="toctree-l1"><a class="reference internal" href="../../../programs/dof6sim.html">Proportional Navigation Guidance - 6 Degrees of Freedom</a></li>
196+
<li class="toctree-l1"><a class="reference internal" href="../../../programs/dof6sim.html">Proportional Navigation Guidance - 6 Degrees of Freedom Simulation</a></li>
181197
<li class="toctree-l1"><a class="reference internal" href="../../../programs/ballistic_coefficient.html">Ballistic Coefficient Estimation - Extended Kalman Filter</a></li>
182198

183199

184-
<li class="toctree-l1"><a class="reference internal" href="../../../programs/car_tracker.html">Car Tracker - Objects Detection and Kalman Filter</a></li>
200+
<li class="toctree-l1"><a class="reference internal" href="../../../programs/car_tracker.html">Cars Tracker – Kalman Filter and Objects Detection Model</a></li>
185201
</ul>
186202
<p aria-level="2" class="caption" role="heading"><span class="caption-text">API</span></p>
187203
<ul class="nav bd-sidenav">
@@ -642,7 +658,7 @@ <h1>Source code for c4dynamics.eqm.derivs</h1><div class="highlight"><pre>
642658

643659
<div class="footer-item">
644660
<p class="last-updated">
645-
Last updated on Dec 01, 2025.
661+
Last updated on Dec 17, 2025.
646662
<br/>
647663
</p>
648664
</div>

‎docs/_modules/c4dynamics/eqm/integrate.html‎

Lines changed: 21 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@
3737
<link rel="preload" as="script" href="../../../_static/scripts/pydata-sphinx-theme.js?digest=dfe6caa3a7d634c4db9b" />
3838
<script src="../../../_static/vendor/fontawesome/6.5.2/js/all.min.js?digest=dfe6caa3a7d634c4db9b"></script>
3939

40-
<script src="../../../_static/documentation_options.js?v=10261ce1"></script>
40+
<script src="../../../_static/documentation_options.js?v=bcae1e9a"></script>
4141
<script src="../../../_static/doctools.js?v=9bcbadda"></script>
4242
<script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
4343
<script src="../../../_static/scripts/sphinx-book-theme.js?v=887ef09a"></script>
@@ -49,7 +49,7 @@
4949
<link rel="search" title="Search" href="../../../search.html" />
5050
<meta name="viewport" content="width=device-width, initial-scale=1"/>
5151
<meta name="docsearch:language" content="en"/>
52-
<meta name="docbuild:last-update" content="Dec 01, 2025"/>
52+
<meta name="docbuild:last-update" content="Dec 17, 2025"/>
5353
</head>
5454

5555

@@ -174,14 +174,30 @@
174174
<li class="toctree-l1"><a class="reference internal" href="../../../concepts/sensors.html">Sensors</a></li>
175175
<li class="toctree-l1"><a class="reference internal" href="../../../concepts/filters.html">Filters</a></li>
176176
<li class="toctree-l1"><a class="reference internal" href="../../../concepts/rl_env.html">Reinforcement Learning Enviroenment</a></li>
177+
</ul>
178+
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Toturials</span></p>
179+
<ul class="nav bd-sidenav">
180+
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/setup_guide.html">Setup Guide</a></li>
181+
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/introduction_guide.html">Interactive Introduction to State Space and State Objects Modeling</a></li>
182+
183+
184+
185+
186+
187+
188+
189+
190+
191+
192+
177193
</ul>
178194
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Use Cases</span></p>
179195
<ul class="nav bd-sidenav">
180-
<li class="toctree-l1"><a class="reference internal" href="../../../programs/dof6sim.html">Proportional Navigation Guidance - 6 Degrees of Freedom</a></li>
196+
<li class="toctree-l1"><a class="reference internal" href="../../../programs/dof6sim.html">Proportional Navigation Guidance - 6 Degrees of Freedom Simulation</a></li>
181197
<li class="toctree-l1"><a class="reference internal" href="../../../programs/ballistic_coefficient.html">Ballistic Coefficient Estimation - Extended Kalman Filter</a></li>
182198

183199

184-
<li class="toctree-l1"><a class="reference internal" href="../../../programs/car_tracker.html">Car Tracker - Objects Detection and Kalman Filter</a></li>
200+
<li class="toctree-l1"><a class="reference internal" href="../../../programs/car_tracker.html">Cars Tracker – Kalman Filter and Objects Detection Model</a></li>
185201
</ul>
186202
<p aria-level="2" class="caption" role="heading"><span class="caption-text">API</span></p>
187203
<ul class="nav bd-sidenav">
@@ -789,7 +805,7 @@ <h1>Source code for c4dynamics.eqm.integrate</h1><div class="highlight"><pre>
789805

790806
<div class="footer-item">
791807
<p class="last-updated">
792-
Last updated on Dec 01, 2025.
808+
Last updated on Dec 17, 2025.
793809
<br/>
794810
</p>
795811
</div>

‎docs/_modules/c4dynamics/filters/ekf.html‎

Lines changed: 21 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@
3737
<link rel="preload" as="script" href="../../../_static/scripts/pydata-sphinx-theme.js?digest=dfe6caa3a7d634c4db9b" />
3838
<script src="../../../_static/vendor/fontawesome/6.5.2/js/all.min.js?digest=dfe6caa3a7d634c4db9b"></script>
3939

40-
<script src="../../../_static/documentation_options.js?v=10261ce1"></script>
40+
<script src="../../../_static/documentation_options.js?v=bcae1e9a"></script>
4141
<script src="../../../_static/doctools.js?v=9bcbadda"></script>
4242
<script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
4343
<script src="../../../_static/scripts/sphinx-book-theme.js?v=887ef09a"></script>
@@ -49,7 +49,7 @@
4949
<link rel="search" title="Search" href="../../../search.html" />
5050
<meta name="viewport" content="width=device-width, initial-scale=1"/>
5151
<meta name="docsearch:language" content="en"/>
52-
<meta name="docbuild:last-update" content="Dec 01, 2025"/>
52+
<meta name="docbuild:last-update" content="Dec 17, 2025"/>
5353
</head>
5454

5555

@@ -174,14 +174,30 @@
174174
<li class="toctree-l1"><a class="reference internal" href="../../../concepts/sensors.html">Sensors</a></li>
175175
<li class="toctree-l1"><a class="reference internal" href="../../../concepts/filters.html">Filters</a></li>
176176
<li class="toctree-l1"><a class="reference internal" href="../../../concepts/rl_env.html">Reinforcement Learning Enviroenment</a></li>
177+
</ul>
178+
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Toturials</span></p>
179+
<ul class="nav bd-sidenav">
180+
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/setup_guide.html">Setup Guide</a></li>
181+
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/introduction_guide.html">Interactive Introduction to State Space and State Objects Modeling</a></li>
182+
183+
184+
185+
186+
187+
188+
189+
190+
191+
192+
177193
</ul>
178194
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Use Cases</span></p>
179195
<ul class="nav bd-sidenav">
180-
<li class="toctree-l1"><a class="reference internal" href="../../../programs/dof6sim.html">Proportional Navigation Guidance - 6 Degrees of Freedom</a></li>
196+
<li class="toctree-l1"><a class="reference internal" href="../../../programs/dof6sim.html">Proportional Navigation Guidance - 6 Degrees of Freedom Simulation</a></li>
181197
<li class="toctree-l1"><a class="reference internal" href="../../../programs/ballistic_coefficient.html">Ballistic Coefficient Estimation - Extended Kalman Filter</a></li>
182198

183199

184-
<li class="toctree-l1"><a class="reference internal" href="../../../programs/car_tracker.html">Car Tracker - Objects Detection and Kalman Filter</a></li>
200+
<li class="toctree-l1"><a class="reference internal" href="../../../programs/car_tracker.html">Cars Tracker – Kalman Filter and Objects Detection Model</a></li>
185201
</ul>
186202
<p aria-level="2" class="caption" role="heading"><span class="caption-text">API</span></p>
187203
<ul class="nav bd-sidenav">
@@ -753,7 +769,7 @@ <h1>Source code for c4dynamics.filters.ekf</h1><div class="highlight"><pre>
753769

754770
<div class="footer-item">
755771
<p class="last-updated">
756-
Last updated on Dec 01, 2025.
772+
Last updated on Dec 17, 2025.
757773
<br/>
758774
</p>
759775
</div>

‎docs/_modules/c4dynamics/filters/kalman.html‎

Lines changed: 21 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@
3737
<link rel="preload" as="script" href="../../../_static/scripts/pydata-sphinx-theme.js?digest=dfe6caa3a7d634c4db9b" />
3838
<script src="../../../_static/vendor/fontawesome/6.5.2/js/all.min.js?digest=dfe6caa3a7d634c4db9b"></script>
3939

40-
<script src="../../../_static/documentation_options.js?v=10261ce1"></script>
40+
<script src="../../../_static/documentation_options.js?v=bcae1e9a"></script>
4141
<script src="../../../_static/doctools.js?v=9bcbadda"></script>
4242
<script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
4343
<script src="../../../_static/scripts/sphinx-book-theme.js?v=887ef09a"></script>
@@ -49,7 +49,7 @@
4949
<link rel="search" title="Search" href="../../../search.html" />
5050
<meta name="viewport" content="width=device-width, initial-scale=1"/>
5151
<meta name="docsearch:language" content="en"/>
52-
<meta name="docbuild:last-update" content="Dec 01, 2025"/>
52+
<meta name="docbuild:last-update" content="Dec 17, 2025"/>
5353
</head>
5454

5555

@@ -174,14 +174,30 @@
174174
<li class="toctree-l1"><a class="reference internal" href="../../../concepts/sensors.html">Sensors</a></li>
175175
<li class="toctree-l1"><a class="reference internal" href="../../../concepts/filters.html">Filters</a></li>
176176
<li class="toctree-l1"><a class="reference internal" href="../../../concepts/rl_env.html">Reinforcement Learning Enviroenment</a></li>
177+
</ul>
178+
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Toturials</span></p>
179+
<ul class="nav bd-sidenav">
180+
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/setup_guide.html">Setup Guide</a></li>
181+
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/introduction_guide.html">Interactive Introduction to State Space and State Objects Modeling</a></li>
182+
183+
184+
185+
186+
187+
188+
189+
190+
191+
192+
177193
</ul>
178194
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Use Cases</span></p>
179195
<ul class="nav bd-sidenav">
180-
<li class="toctree-l1"><a class="reference internal" href="../../../programs/dof6sim.html">Proportional Navigation Guidance - 6 Degrees of Freedom</a></li>
196+
<li class="toctree-l1"><a class="reference internal" href="../../../programs/dof6sim.html">Proportional Navigation Guidance - 6 Degrees of Freedom Simulation</a></li>
181197
<li class="toctree-l1"><a class="reference internal" href="../../../programs/ballistic_coefficient.html">Ballistic Coefficient Estimation - Extended Kalman Filter</a></li>
182198

183199

184-
<li class="toctree-l1"><a class="reference internal" href="../../../programs/car_tracker.html">Car Tracker - Objects Detection and Kalman Filter</a></li>
200+
<li class="toctree-l1"><a class="reference internal" href="../../../programs/car_tracker.html">Cars Tracker – Kalman Filter and Objects Detection Model</a></li>
185201
</ul>
186202
<p aria-level="2" class="caption" role="heading"><span class="caption-text">API</span></p>
187203
<ul class="nav bd-sidenav">
@@ -1163,7 +1179,7 @@ <h1>Source code for c4dynamics.filters.kalman</h1><div class="highlight"><pre>
11631179

11641180
<div class="footer-item">
11651181
<p class="last-updated">
1166-
Last updated on Dec 01, 2025.
1182+
Last updated on Dec 17, 2025.
11671183
<br/>
11681184
</p>
11691185
</div>

0 commit comments

Comments
 (0)