Skip to content

Commit 507345a

Browse files
committed
updated documentation
1 parent 73f1c59 commit 507345a

File tree

872 files changed

+3486
-1695
lines changed

Some content is hidden

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

872 files changed

+3486
-1695
lines changed

CMakeLists.txt

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11
# ---------------------------------------------------------------------------------------------------------------------
22
#
3-
# Copyright (C) Microsoft Corporation. All rights reserved.
3+
# Copyright (C) Microsoft Corporation.
4+
# Copyright (c) 2025 IAMAI Simulations
5+
#
6+
# MIT License. All rights reserved.
47
#
58
# Module Name:
69
#

README.md

Lines changed: 13 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
Project AirSim is a simulation platform for drones, robots, and other autonomous systems.
44

5-
Building on the previous work of **[AirSim](https://github.com/microsoft/AirSim)**, it leverages **[Unreal Engine 4](https://www.unrealengine.com/)** to provide photo-realistic visuals, while providing the simulation framework needed to integrate custom physics, controllers, actuators, and sensors to develop an autonomous system.
5+
Building on the previous work of **[AirSim](https://github.com/microsoft/AirSim)**, it leverages **[Unreal Engine 5](https://www.unrealengine.com/)** to provide photo-realistic visuals, while providing the simulation framework needed to integrate custom physics, controllers, actuators, and sensors to develop an autonomous system.
66

77
Project AirSim consists of three main layers:
88

@@ -12,47 +12,31 @@ Project AirSim consists of three main layers:
1212

1313
3. **Project AirSim Client Library** - End-user library to enable API calls to interact with the robot and simulation over a network connection
1414

15-
For more details on the architecture, see **[Project AirSim Architecture Overview](docs/internal/use_source.md#airsim-v-next-architecture-overview)**.
15+
For more details on the architecture, see **[Project AirSim Architecture Overview](docs/development/use_source.md#airsim-v-next-architecture-overview)**.
1616

17-
Project AirSim currently supports Windows 10/Server 2019 and Ubuntu 20.04. For more info about hardware specs for working with Project AirSim, see **[System Specifications](docs/system_specs.md)**.
17+
Project AirSim currently supports Windows 11 and Ubuntu 20.04. For more info about hardware specs for working with Project AirSim, see **[System Specifications](docs/system_specs.md)**.
1818

1919
![Drone flying in Blocks environment](docs/images/drone_in_blocks.jpg)
2020

21-
## What's New
22-
23-
For a complete list of changes, view our **[Changelog](docs/changelog.md)**.
24-
2521
## Getting Started
2622

2723
See **[Installing system prerequisites](docs/system_specs.md#installing-system-prerequisites)** for information about Windows/Linux system setup needed before running Project AirSim.
2824

29-
### 1. Pre-built environment binaries
25+
### 1. Develop with Project AirSim source
3026

31-
> I just want to download and run a Project AirSim environment and drive it with some Python code.
27+
> I'm going to build the sim libs, Plugin, Blocks, and my own UE project environment from the ground up so I can customize it to my application.
3228
33-
#### **[Use pre-built binary environments](docs/internal/use_prebuilt.md)**
29+
#### **[Build from source as a developer](docs/development/use_source.md)**
3430

3531
### 2. Drop-in Project AirSim Plugin
3632

3733
> I want to try adding the Project AirSim Plugin to my own UE project environment so I can build some autonomous stuff.
3834
3935
#### **[Use Project AirSim Plugin in custom environments](docs/use_plugin.md)**
4036

41-
### 3. Develop with Project AirSim source
42-
43-
> I'm going to build the sim libs, Plugin, Blocks, and my own UE project environment from the ground up so I can customize it to my application.
44-
45-
#### **[Build from source as a developer](docs/internal/use_source.md)**
46-
47-
### 4. Develop autonomy capabilities using Project AirSim
37+
## Running Headless (Docker)
4838

49-
> I'm going to explore/build machine learning applications and models for autonomous perception/planning/control tasks using pre-trained models, datasets and learning environments from Project AirSim
50-
51-
#### **[Leverage/Build autonomy building-blocks using Project AirSim](docs/autonomy/autonomy.md)
52-
53-
## Running Headless (Docker, Azure Cloud)
54-
55-
If you need to run a Project AirSim simulation on a headless system, such as in a Docker container or in the cloud on an Azure VM, you can enable off-screen rendering by adding the `-RenderOffScreen` argument when launching the Unreal environment executable:
39+
If you need to run a Project AirSim simulation on a headless system, such as in a Docker container, you can enable off-screen rendering by adding the `-RenderOffScreen` argument when launching the Unreal environment executable:
5640

5741
```
5842
Blocks{.exe/.sh} -RenderOffScreen
@@ -64,7 +48,7 @@ If you are running without GPU access and want to run without any image renderin
6448
Blocks{.exe/.sh} -nullrhi
6549
```
6650

67-
These arguments can also be used while debugging in VS Code by modifying the `launch.json` file, or in Visual Studio 2019 by modifying the project's `Configuration Properties`. See **[Running Headless (Docker, Azure Cloud)](docs/internal/headless_cloud.md)** for more details.
51+
These arguments can also be used while debugging in VS Code by modifying the `launch.json` file, or in Visual Studio 2022 by modifying the project's `Configuration Properties`. See **[Running Headless (Docker, Azure Cloud)](docs/development/headless_cloud.md)** for more details.
6852

6953
## Reference
7054

@@ -112,11 +96,6 @@ These arguments can also be used while debugging in VS Code by modifying the `la
11296
- **[Fast Physics](docs/physics/fast_physics.md)**
11397
- **[Matlab Physics](docs/physics/matlab_physics.md)**
11498

115-
### Autonomy Blocks
116-
117-
- **[Autonomy Building-Blocks](docs/autonomy/autonomy.md)**
118-
- **[Autonomy Gym](docs/autonomy/gym/gym_envs.md)**
119-
12099
## FAQ
121100

122101
If you run into problems, check the **[FAQ](docs/faq.md)** for help.
@@ -131,4 +110,7 @@ This project may contain trademarks or logos for projects, products, or services
131110

132111
---
133112

134-
Copyright (C) Microsoft Corporation. All rights reserved.
113+
Copyright (C) Microsoft Corporation.
114+
Copyright (C) IAMAI Consulting.
115+
116+
MIT License

SECURITY.md

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

33
## Security
44

5-
Microsoft takes the security of our software products and services seriously, which includes all source code repositories managed through our GitHub organizations, which include [Microsoft](https://github.com/Microsoft), [Azure](https://github.com/Azure), [DotNet](https://github.com/dotnet), [AspNet](https://github.com/aspnet) and [Xamarin](https://github.com/xamarin).
5+
Microsoft takes the security of our software products and services seriously, which includes all source code repositories managed through our GitHub organizations, which include [Microsoft](https://github.com/Microsoft), [DotNet](https://github.com/dotnet), [AspNet](https://github.com/aspnet) and [Xamarin](https://github.com/xamarin).
66

77
If you believe you have found a security vulnerability in any Microsoft-owned repository that meets [Microsoft's definition of a security vulnerability](https://aka.ms/security.md/definition), please report it to us as described below.
88

build.cmd

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
1-
REM Copyright (C) Microsoft Corporation. All rights reserved.
1+
REM Copyright (C) Microsoft Corporation.
2+
Copyright (C) IAMAI Consulting.
3+
4+
MIT License.
25

36
@echo off
47
setlocal

build.sh

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
#!/bin/bash
2-
# Copyright (C) Microsoft Corporation. All rights reserved.
2+
# Copyright (C) Microsoft Corporation.
3+
Copyright (C) IAMAI Consulting.
4+
5+
MIT License.
36

47
set -e
58
make -f build_linux.mk $1

build_docs.bat

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
1-
REM Copyright (C) Microsoft Corporation. All rights reserved.
1+
REM Copyright (C) Microsoft Corporation.
2+
Copyright (C) IAMAI Consulting.
3+
4+
MIT License.
25

36
@echo off
47
SETLOCAL

build_docs.sh

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
#!/bin/bash
2-
# Copyright (C) Microsoft Corporation. All rights reserved.
2+
# Copyright (C) Microsoft Corporation.
3+
Copyright (C) IAMAI Consulting.
4+
5+
MIT License.
36

47
## Install mkdocs
58
# python3.7 -m venv env

build_docs_external.bat

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
1-
REM Copyright (C) Microsoft Corporation. All rights reserved.
1+
REM Copyright (C) Microsoft Corporation.
2+
Copyright (C) IAMAI Consulting.
3+
4+
MIT License.
25

36
@echo off
47
SETLOCAL

build_docs_external.sh

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
#!/bin/bash
2-
# Copyright (C) Microsoft Corporation. All rights reserved.
2+
# Copyright (C) Microsoft Corporation.
3+
Copyright (C) IAMAI Consulting.
4+
5+
MIT License.
36

47
## Install mkdocs
58
# python3.7 -m venv env

build_linux.mk

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11
# ---------------------------------------------------------------------------------------------------------------------
22
#
3-
# Copyright (C) Microsoft Corporation. All rights reserved.
3+
# Copyright (C) Microsoft Corporation.
4+
# Copyright (c) 2025 IAMAI Simulations
5+
#
6+
# MIT License. All rights reserved.
47
#
58
# Module Name:
69
#

0 commit comments

Comments
 (0)