Skip to content

Commit a2eb14e

Browse files
author
Docs Deploy
committed
Deployed 294a733 to main with MkDocs 1.6.1 and mike 2.1.4
1 parent 512f866 commit a2eb14e

File tree

154 files changed

+24391
-892
lines changed

Some content is hidden

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

154 files changed

+24391
-892
lines changed

main/404.html

Lines changed: 109 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1618,6 +1618,8 @@
16181618

16191619

16201620

1621+
1622+
16211623

16221624

16231625

@@ -1901,14 +1903,14 @@
19011903

19021904

19031905
<div class="md-nav__link md-nav__container">
1904-
<a href="/docs/main/docs/simulation/simple_sim/" class="md-nav__link ">
1906+
<a href="/docs/main/docs/simulation/ms-airsim/" class="md-nav__link ">
19051907

19061908

19071909

19081910
<span class="md-ellipsis">
19091911

19101912

1911-
Simple Sim
1913+
Microsoft AirSim (legacy)
19121914

19131915

19141916

@@ -1930,6 +1932,111 @@
19301932
<span class="md-nav__icon md-icon"></span>
19311933

19321934

1935+
Microsoft AirSim (legacy)
1936+
1937+
1938+
</label>
1939+
<ul class="md-nav__list" data-md-scrollfix>
1940+
1941+
1942+
1943+
1944+
1945+
1946+
1947+
1948+
1949+
<li class="md-nav__item">
1950+
<a href="/docs/main/docs/simulation/ms-airsim/docker/" class="md-nav__link">
1951+
1952+
1953+
1954+
<span class="md-ellipsis">
1955+
1956+
1957+
Docker
1958+
1959+
1960+
1961+
</span>
1962+
1963+
1964+
1965+
</a>
1966+
</li>
1967+
1968+
1969+
1970+
1971+
</ul>
1972+
</nav>
1973+
1974+
</li>
1975+
1976+
1977+
1978+
1979+
1980+
1981+
1982+
1983+
1984+
1985+
1986+
1987+
1988+
1989+
1990+
1991+
1992+
1993+
1994+
1995+
1996+
1997+
1998+
1999+
2000+
2001+
2002+
2003+
<li class="md-nav__item md-nav__item--nested">
2004+
2005+
2006+
2007+
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_4" >
2008+
2009+
2010+
<div class="md-nav__link md-nav__container">
2011+
<a href="/docs/main/docs/simulation/simple_sim/" class="md-nav__link ">
2012+
2013+
2014+
2015+
<span class="md-ellipsis">
2016+
2017+
2018+
Simple Sim
2019+
2020+
2021+
2022+
</span>
2023+
2024+
2025+
2026+
</a>
2027+
2028+
2029+
<label class="md-nav__link " for="__nav_4_4" id="__nav_4_4_label" tabindex="0">
2030+
<span class="md-nav__icon md-icon"></span>
2031+
</label>
2032+
2033+
</div>
2034+
2035+
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_4_label" aria-expanded="false">
2036+
<label class="md-nav__title" for="__nav_4_4">
2037+
<span class="md-nav__icon md-icon"></span>
2038+
2039+
19332040
Simple Sim
19342041

19352042

main/AGENTS/index.html

Lines changed: 122 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1625,6 +1625,8 @@
16251625

16261626

16271627

1628+
1629+
16281630

16291631

16301632

@@ -1908,14 +1910,14 @@
19081910

19091911

19101912
<div class="md-nav__link md-nav__container">
1911-
<a href="../docs/simulation/simple_sim/" class="md-nav__link ">
1913+
<a href="../docs/simulation/ms-airsim/" class="md-nav__link ">
19121914

19131915

19141916

19151917
<span class="md-ellipsis">
19161918

19171919

1918-
Simple Sim
1920+
Microsoft AirSim (legacy)
19191921

19201922

19211923

@@ -1937,6 +1939,111 @@
19371939
<span class="md-nav__icon md-icon"></span>
19381940

19391941

1942+
Microsoft AirSim (legacy)
1943+
1944+
1945+
</label>
1946+
<ul class="md-nav__list" data-md-scrollfix>
1947+
1948+
1949+
1950+
1951+
1952+
1953+
1954+
1955+
1956+
<li class="md-nav__item">
1957+
<a href="../docs/simulation/ms-airsim/docker/" class="md-nav__link">
1958+
1959+
1960+
1961+
<span class="md-ellipsis">
1962+
1963+
1964+
Docker
1965+
1966+
1967+
1968+
</span>
1969+
1970+
1971+
1972+
</a>
1973+
</li>
1974+
1975+
1976+
1977+
1978+
</ul>
1979+
</nav>
1980+
1981+
</li>
1982+
1983+
1984+
1985+
1986+
1987+
1988+
1989+
1990+
1991+
1992+
1993+
1994+
1995+
1996+
1997+
1998+
1999+
2000+
2001+
2002+
2003+
2004+
2005+
2006+
2007+
2008+
2009+
2010+
<li class="md-nav__item md-nav__item--nested">
2011+
2012+
2013+
2014+
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_4" >
2015+
2016+
2017+
<div class="md-nav__link md-nav__container">
2018+
<a href="../docs/simulation/simple_sim/" class="md-nav__link ">
2019+
2020+
2021+
2022+
<span class="md-ellipsis">
2023+
2024+
2025+
Simple Sim
2026+
2027+
2028+
2029+
</span>
2030+
2031+
2032+
2033+
</a>
2034+
2035+
2036+
<label class="md-nav__link " for="__nav_4_4" id="__nav_4_4_label" tabindex="0">
2037+
<span class="md-nav__icon md-icon"></span>
2038+
</label>
2039+
2040+
</div>
2041+
2042+
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_4_label" aria-expanded="false">
2043+
<label class="md-nav__title" for="__nav_4_4">
2044+
<span class="md-nav__icon md-icon"></span>
2045+
2046+
19402047
Simple Sim
19412048

19422049

@@ -5022,12 +5129,12 @@ <h1 id="agentsmd">AGENTS.md<a class="headerlink" href="#agentsmd" title="Permane
50225129
<p>This file provides guidance to AI coding agents (OpenHands, Claude Code, etc.) when working with the AirStack repository.</p>
50235130
<h2 id="quick-start-for-ai-agents">Quick Start for AI Agents<a class="headerlink" href="#quick-start-for-ai-agents" title="Permanent link">&para;</a></h2>
50245131
<p><strong>Project:</strong> AirStack - Comprehensive autonomous aerial robotics stack developed by AirLab CMU</p>
5025-
<p><strong>Stack:</strong> ROS 2 Jazzy | Docker-based development | Isaac Sim with Pegasus extension | Field robotics</p>
5132+
<p><strong>Stack:</strong> ROS 2 Jazzy | Docker-based development | Isaac Sim with Pegasus extension | Microsoft AirSim (legacy, UE4) | Field robotics</p>
50265133
<p><strong>Primary Goal:</strong> Enable agents to understand the architecture, implement new algorithms/modules, and integrate them correctly into the layered autonomy stack.</p>
50275134
<h2 id="repository-purpose">Repository Purpose<a class="headerlink" href="#repository-purpose" title="Permanent link">&para;</a></h2>
50285135
<p>AirStack provides a complete end-to-end system for autonomous drone operations including:
50295136
- Modular autonomy stack (interface, sensors, perception, local planning, global planning, behavior)
5030-
- High-fidelity Isaac Sim simulation environment
5137+
- High-fidelity simulation environments (Isaac Sim with Pegasus extension, Microsoft AirSim legacy/UE4)
50315138
- Ground Control Station for mission planning and monitoring
50325139
- Multi-robot coordination capabilities
50335140
- Hardware deployment tools</p>
@@ -5044,11 +5151,12 @@ <h3 id="high-level-structure">High-Level Structure<a class="headerlink" href="#h
50445151
</span><span id="__span-0-8"><a id="__codelineno-0-8" name="__codelineno-0-8" href="#__codelineno-0-8"></a>│ ├── global/ # Global planning &amp; mapping
50455152
</span><span id="__span-0-9"><a id="__codelineno-0-9" name="__codelineno-0-9" href="#__codelineno-0-9"></a>│ └── behavior/ # High-level mission execution
50465153
</span><span id="__span-0-10"><a id="__codelineno-0-10" name="__codelineno-0-10" href="#__codelineno-0-10"></a>├── simulation/isaac-sim/ # Isaac Sim (Pegasus extension)
5047-
</span><span id="__span-0-11"><a id="__codelineno-0-11" name="__codelineno-0-11" href="#__codelineno-0-11"></a>├── gcs/ # Ground Control Station
5048-
</span><span id="__span-0-12"><a id="__codelineno-0-12" name="__codelineno-0-12" href="#__codelineno-0-12"></a>├── common/ # Shared packages &amp; utilities
5049-
</span><span id="__span-0-13"><a id="__codelineno-0-13" name="__codelineno-0-13" href="#__codelineno-0-13"></a>├── docs/ # MkDocs documentation
5050-
</span><span id="__span-0-14"><a id="__codelineno-0-14" name="__codelineno-0-14" href="#__codelineno-0-14"></a>├── mkdocs.yml # MkDocs config file
5051-
</span><span id="__span-0-15"><a id="__codelineno-0-15" name="__codelineno-0-15" href="#__codelineno-0-15"></a>└── .agents/skills/ # Detailed workflow guides for agents
5154+
</span><span id="__span-0-11"><a id="__codelineno-0-11" name="__codelineno-0-11" href="#__codelineno-0-11"></a>├── simulation/ms-airsim/ # AirSim (UE4 + PX4 SITL)
5155+
</span><span id="__span-0-12"><a id="__codelineno-0-12" name="__codelineno-0-12" href="#__codelineno-0-12"></a>├── gcs/ # Ground Control Station
5156+
</span><span id="__span-0-13"><a id="__codelineno-0-13" name="__codelineno-0-13" href="#__codelineno-0-13"></a>├── common/ # Shared packages &amp; utilities
5157+
</span><span id="__span-0-14"><a id="__codelineno-0-14" name="__codelineno-0-14" href="#__codelineno-0-14"></a>├── docs/ # MkDocs documentation
5158+
</span><span id="__span-0-15"><a id="__codelineno-0-15" name="__codelineno-0-15" href="#__codelineno-0-15"></a>├── mkdocs.yml # MkDocs config file
5159+
</span><span id="__span-0-16"><a id="__codelineno-0-16" name="__codelineno-0-16" href="#__codelineno-0-16"></a>└── .agents/skills/ # Detailed workflow guides for agents
50525160
</span></code></pre></div>
50535161
<h3 id="layered-autonomy-pattern">Layered Autonomy Pattern<a class="headerlink" href="#layered-autonomy-pattern" title="Permanent link">&para;</a></h3>
50545162
<p>The autonomy stack follows a <strong>layered architecture</strong> where data flows through processing stages:</p>
@@ -5258,7 +5366,7 @@ <h3 id="testing-levels">Testing Levels<a class="headerlink" href="#testing-level
52585366
<p>Located in module's <code>test/</code> directory</p>
52595367
</li>
52605368
<li>
5261-
<p><strong>System Level:</strong> Full simulation tests in Isaac Sim</p>
5369+
<p><strong>System Level:</strong> Full simulation tests (Isaac Sim or Microsoft AirSim legacy)</p>
52625370
</li>
52635371
<li>End-to-end autonomy stack testing</li>
52645372
<li>Real sensor simulation</li>
@@ -5319,7 +5427,8 @@ <h2 id="package-templates">Package Templates<a class="headerlink" href="#package
53195427
<h2 id="docker-architecture">Docker Architecture<a class="headerlink" href="#docker-architecture" title="Permanent link">&para;</a></h2>
53205428
<p>Each major component has its own Docker container:
53215429
- <strong>robot</strong>: ROS 2 autonomy stack (Jazzy)
5322-
- <strong>isaac-sim</strong>: NVIDIA Isaac Sim with Pegasus extension
5430+
- <strong>isaac-sim</strong>: NVIDIA Isaac Sim with Pegasus extension (profile: <code>desktop</code> or <code>robot</code>)
5431+
- <strong>airsim</strong>: AirSim UE4 binary + PX4 SITL + ROS 2 bridge (profile: <code>ms-airsim</code>)
53235432
- <strong>gcs</strong>: Ground Control Station
53245433
- <strong>docs</strong>: Documentation building (MkDocs)</p>
53255434
<p><strong>Configuration:</strong>
@@ -5376,7 +5485,7 @@ <h2 id="critical-pitfalls-to-avoid">Critical Pitfalls to Avoid<a class="headerli
53765485
</li>
53775486
<li>❌ Only testing module in isolation</li>
53785487
<li>✅ Test in full autonomy stack context</li>
5379-
<li>✅ Verify in Isaac Sim simulation</li>
5488+
<li>✅ Verify in Isaac Sim or Microsoft AirSim (legacy) simulation</li>
53805489
</ol>
53815490
<h2 id="key-differences-from-claudemd">Key Differences from CLAUDE.md<a class="headerlink" href="#key-differences-from-claudemd" title="Permanent link">&para;</a></h2>
53825491
<p>This guide supersedes <code>CLAUDE.md</code> (which now symlinks here). Key updates:</p>
@@ -5408,6 +5517,7 @@ <h3 id="airstack-documentation">AirStack Documentation<a class="headerlink" href
54085517
<li><a href="../docs/getting_started/">Getting Started</a></li>
54095518
<li><a href="../docs/robot/autonomy/">Autonomy Stack Overview</a></li>
54105519
<li><a href="../docs/simulation/isaac_sim/">Isaac Sim Setup</a></li>
5520+
<li><a href="../docs/simulation/ms-airsim/">Microsoft AirSim (legacy) Setup</a></li>
54115521
<li><a href="docs/development/testing/index.md">Testing Guide</a></li>
54125522
</ul>
54135523
<h3 id="external-tools">External Tools<a class="headerlink" href="#external-tools" title="Permanent link">&para;</a></h3>

0 commit comments

Comments
 (0)