doc cleanup

Kokika · Jun 13, 2024 · 7d32110 · 7d32110
1 parent 91f66a3
commit 7d32110
Show file tree

Hide file tree

Showing 41 changed files with 81 additions and 80 deletions.
diff --git a/AUTHORS.md b/AUTHORS.md
@@ -6,6 +6,8 @@ AirSim was originally created by [Shital Shah](https://github.com/sytelus) durin
 
 List of all contributors since our first release in February 2017 can be [found here](https://github.com/Microsoft/AirSim/graphs/contributors).
 
+Afterwards, Cosys-Lab researchers have started to add new features and improvements to AirSim. The following publications are the result of this work:
+
 # Cosys-Lab publications
 
 - [Cosys-AirSim: A Real-Time Simulation Framework Expanded for Complex Industrial Applications](https://arxiv.org/abs/2303.13381)

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -226,7 +226,7 @@
 ### November, 2018
 * Added Weather Effects and [APIs](apis.md#weather-apis)
 * Added [Time of Day API](apis.md#time-of-day-api)
-* An experimental integration of [AirSim on Unity](https://github.com/Microsoft/AirSim/tree/main/Unity) is now available. Learn more in [Unity blog post](https://blogs.unity3d.com/2018/11/14/airsim-on-unity-experiment-with-autonomous-vehicle-simulation). 
+* An experimental integration of [AirSim on Unity](https://cosysgit.uantwerpen.be/sensorsimulation/airsim/-/tree/master/Unity) is now available. Learn more in [Unity blog post](https://blogs.unity3d.com/2018/11/14/airsim-on-unity-experiment-with-autonomous-vehicle-simulation). 
 * [New environments](https://github.com/Microsoft/AirSim/releases/tag/v1.2.1): Forest, Plains (windmill farm), TalkingHeads (human head simulation), TrapCam (animal detection via camera)
 * Highly efficient [NoDisplay view mode](settings.md#viewmode) to turn off main screen rendering so you can capture images at high rate
 * [Enable/disable sensors](https://github.com/Microsoft/AirSim/pull/1479) via settings
@@ -237,7 +237,7 @@
 * [Custom speed units](https://github.com/Microsoft/AirSim/pull/1181)
 * [ROS publisher](https://github.com/Microsoft/AirSim/pull/1135)
 * [simSetObjectPose API](https://github.com/Microsoft/AirSim/pull/1161)
-* [Character Control APIs](https://github.com/Microsoft/AirSim/blob/main/PythonClient/airsim/client.py#L137) (works on TalkingHeads binaries in release)
+* [Character Control APIs](https://cosysgit.uantwerpen.be/sensorsimulation/airsim/-/tree/master/PythonClient/airsim/client.py#L137) (works on TalkingHeads binaries in release)
 * [Arducopter Solo Support](https://github.com/Microsoft/AirSim/pull/1387)
 * [Linux install without sudo access](https://github.com/Microsoft/AirSim/pull/1434)
 * [Kinect like ROS publisher](https://github.com/Microsoft/AirSim/pull/1298)

diff --git a/Examples/DataCollection/DataCollectorSGM_settings.json b/Examples/DataCollection/DataCollectorSGM_settings.json
@@ -1,5 +1,5 @@
 {
-  "SeeDocsAt": "https://github.com/Microsoft/AirSim/blob/main/docs/settings.md",
+  "SeeDocsAt": "https://cosysgit.uantwerpen.be/sensorsimulation/airsim/-/tree/master/docs/settings.md",
   "SettingsVersion": 1.2,
   "SimMode": "ComputerVision",
   "CameraDefaults": {

diff --git a/Examples/DepthNav/DepthNav_settings.json b/Examples/DepthNav/DepthNav_settings.json
@@ -1,5 +1,5 @@
 {
-  "SeeDocsAt": "https://github.com/Microsoft/AirSim/blob/main/docs/settings.md",
+  "SeeDocsAt": "https://cosysgit.uantwerpen.be/sensorsimulation/airsim/-/tree/master/docs/settings.md",
   "SettingsVersion": 1.2,
   "SimMode": "ComputerVision",
   "CameraDefaults": {

diff --git a/GazeboDrone/README.md b/GazeboDrone/README.md
@@ -1,3 +1,3 @@
 # Welcome to GazeboDrone
 
-This page has moved [here](https://github.com/microsoft/AirSim/blob/main/docs/gazebo_drone.md).
+This page has moved [here](https://cosysgit.uantwerpen.be/sensorsimulation/airsim/-/tree/master/docs/gazebo_drone.md).
diff --git a/MavLinkCom/MavLinkMoCap/Readme.md b/MavLinkCom/MavLinkMoCap/Readme.md
@@ -1,3 +1,3 @@
 # Welcome to MavLinkMoCap
 
-This page has moved [here](https://github.com/microsoft/AirSim/blob/main/docs/mavlinkcom_mocap.md).
+This page has moved [here](https://cosysgit.uantwerpen.be/sensorsimulation/airsim/-/tree/master/docs/mavlinkcom_mocap.md).
diff --git a/MavLinkCom/README.md b/MavLinkCom/README.md
@@ -1,3 +1,3 @@
 # Welcome to MavLinkCom
 
-This page has moved [here](https://github.com/microsoft/AirSim/blob/main/docs/mavlinkcom.md).
+This page has moved [here](https://cosysgit.uantwerpen.be/sensorsimulation/airsim/-/tree/master/docs/mavlinkcom.md).
diff --git a/PythonClient/computer_vision/cv_capture.py b/PythonClient/computer_vision/cv_capture.py
@@ -1,5 +1,5 @@
 # In settings.json first activate computer vision mode: 
-# https://github.com/Microsoft/AirSim/blob/main/docs/image_apis.md#computer-vision-mode
+# https://cosysgit.uantwerpen.be/sensorsimulation/airsim/-/tree/master/docs/image_apis.md#computer-vision-mode
 
 import setup_path 
 import airsim

diff --git a/PythonClient/computer_vision/cv_mode.py b/PythonClient/computer_vision/cv_mode.py
@@ -1,5 +1,5 @@
 # In settings.json first activate computer vision mode:
-# https://github.com/Microsoft/AirSim/blob/main/docs/image_apis.md#computer-vision-mode
+# https://cosysgit.uantwerpen.be/sensorsimulation/airsim/-/tree/master/docs/image_apis.md#computer-vision-mode
 
 import setup_path
 import airsim

diff --git a/PythonClient/computer_vision/cv_navigate.py b/PythonClient/computer_vision/cv_navigate.py
@@ -1,6 +1,6 @@
 
 # In settings.json first activate computer vision mode: 
-# https://github.com/Microsoft/AirSim/blob/main/docs/image_apis.md#computer-vision-mode
+# https://cosysgit.uantwerpen.be/sensorsimulation/airsim/-/tree/master/docs/image_apis.md#computer-vision-mode
 
 import setup_path 
 import airsim

diff --git a/PythonClient/computer_vision/getpos.py b/PythonClient/computer_vision/getpos.py
@@ -1,5 +1,5 @@
 # In settings.json first activate computer vision mode: 
-# https://github.com/Microsoft/AirSim/blob/main/docs/image_apis.md#computer-vision-mode
+# https://cosysgit.uantwerpen.be/sensorsimulation/airsim/-/tree/master/docs/image_apis.md#computer-vision-mode
 
 import setup_path 
 import airsim

diff --git a/PythonClient/computer_vision/ground_truth.py b/PythonClient/computer_vision/ground_truth.py
@@ -1,5 +1,5 @@
 # In settings.json first activate computer vision mode: 
-# https://github.com/Microsoft/AirSim/blob/main/docs/image_apis.md#computer-vision-mode
+# https://cosysgit.uantwerpen.be/sensorsimulation/airsim/-/tree/master/docs/image_apis.md#computer-vision-mode
 
 import setup_path 
 import airsim

diff --git a/PythonClient/computer_vision/objects.py b/PythonClient/computer_vision/objects.py
@@ -1,5 +1,5 @@
 # In settings.json first activate computer vision mode: 
-# https://github.com/Microsoft/AirSim/blob/main/docs/image_apis.md#computer-vision-mode
+# https://cosysgit.uantwerpen.be/sensorsimulation/airsim/-/tree/master/docs/image_apis.md#computer-vision-mode
 
 import setup_path 
 import airsim

diff --git a/PythonClient/computer_vision/segmentation.py b/PythonClient/computer_vision/segmentation.py
@@ -1,5 +1,5 @@
 # In settings.json first activate computer vision mode: 
-# https://github.com/Microsoft/AirSim/blob/main/docs/image_apis.md#computer-vision-mode
+# https://cosysgit.uantwerpen.be/sensorsimulation/airsim/-/tree/master/docs/image_apis.md#computer-vision-mode
 
 import airsim
 import cv2

diff --git a/PythonClient/multirotor/multi_agent_drone.py b/PythonClient/multirotor/multi_agent_drone.py
@@ -9,7 +9,7 @@
 # Use below in settings.json with Blocks environment
 """
 {
-	"SeeDocsAt": "https://github.com/Microsoft/AirSim/blob/main/docs/settings.md",
+	"SeeDocsAt": "https://cosysgit.uantwerpen.be/sensorsimulation/airsim/-/tree/master/docs/settings.md",
 	"SettingsVersion": 1.2,
 	"SimMode": "Multirotor",
 	"ClockSpeed": 1,

diff --git a/PythonClient/multirotor/opencv_show.py b/PythonClient/multirotor/opencv_show.py
@@ -1,5 +1,5 @@
 # In settings.json first activate computer vision mode:
-# https://github.com/Microsoft/AirSim/blob/main/docs/image_apis.md#computer-vision-mode
+# https://cosysgit.uantwerpen.be/sensorsimulation/airsim/-/tree/master/docs/image_apis.md#computer-vision-mode
 
 import setup_path
 import airsim

diff --git a/PythonClient/multirotor/sensorframe_lidar_pointcloud.py b/PythonClient/multirotor/sensorframe_lidar_pointcloud.py
@@ -3,7 +3,7 @@
 # Sample settings.json used for this script:
 '''
 {
-    "SeeDocsAt": "https://github.com/Microsoft/AirSim/blob/main/docs/settings_json.md",
+    "SeeDocsAt": "https://cosysgit.uantwerpen.be/sensorsimulation/airsim/-/tree/master/docs/settings_json.md",
     "SettingsVersion": 1.2,
 
     "SimMode": "Multirotor",

diff --git a/PythonClient/multirotor/vehicleframe_lidar_pointcloud.py b/PythonClient/multirotor/vehicleframe_lidar_pointcloud.py
@@ -3,7 +3,7 @@
 # Sample settings.json used for this script:
 '''
 {
-    "SeeDocsAt": "https://github.com/Microsoft/AirSim/blob/main/docs/settings_json.md",
+    "SeeDocsAt": "https://cosysgit.uantwerpen.be/sensorsimulation/airsim/-/tree/master/docs/settings_json.md",
     "SettingsVersion": 1.2,
 
     "SimMode": "Multirotor",

diff --git a/Unreal/Environments/Blocks/Config/DefaultGame.ini b/Unreal/Environments/Blocks/Config/DefaultGame.ini
@@ -2,8 +2,8 @@
 ProjectID=367FFC384956CDC4377673B3217F380D
 ProjectName="Blocks"
 CompanyName=Microsoft Research
-Homepage="https://github.com/microsoft/airsim"
-SupportContact="https://github.com/microsoft/airsim/issues"
+Homepage="https://cosysgit.uantwerpen.be/sensorsimulation/airsim"
+SupportContact="https://cosysgit.uantwerpen.be/sensorsimulation/airsim/-/issues"
 LicensingTerms=MIT Licence
 ProjectDisplayedTitle=NSLOCTEXT("[/Script/EngineSettings]", "8F8B6B2A472F9FDFB69E2B8CFAE8C4E0", "Blocks Environment for AirSim")
 ProjectDebugTitleInfo=NSLOCTEXT("[/Script/EngineSettings]", "F31D7C524A9E9BC66DD2AA922D309408", "Blocks Environment for AirSim")

diff --git a/build.cmd b/build.cmd
@@ -17,7 +17,7 @@ if "%VisualStudioVersion%" lss "17.0" (
     echo(
     echo Hello there! We just upgraded AirSim to Unreal Engine 5.2.1 and Visual Studio 2022.
     echo Here are few easy steps for upgrade so everything is new and shiny:
-    echo https://github.com/Microsoft/AirSim/blob/main/docs/unreal_upgrade.md
+    echo https://cosysgit.uantwerpen.be/sensorsimulation/airsim/-/tree/master/docs/unreal_upgrade.md
     goto :buildfailed_nomsg
 )
 
@@ -141,8 +141,8 @@ IF NOT EXIST Unreal\Plugins\AirSim\Content\VehicleAdv\SUV\v1.2.0 (
         IF EXIST suv_download_tmp rmdir suv_download_tmp /q /s
         mkdir suv_download_tmp
         @echo on
-        REM %powershell% -command "& { Start-BitsTransfer -Source https://github.com/Microsoft/AirSim/releases/download/v1.2.0/car_assets.zip -Destination suv_download_tmp\car_assets.zip }"
-        REM %powershell% -command "& { (New-Object System.Net.WebClient).DownloadFile('https://github.com/Microsoft/AirSim/releases/download/v1.2.0/car_assets.zip', 'suv_download_tmp\car_assets.zip') }"
+        REM %powershell% -command "& { Start-BitsTransfer -Source https://github.com/Cosys-Lab/Cosys-AirSim/releases/download/carassets/cosys_car_assets.zip -Destination suv_download_tmp\car_assets.zip }"
+        REM %powershell% -command "& { (New-Object System.Net.WebClient).DownloadFile('https://github.com/Cosys-Lab/Cosys-AirSim/releases/download/carassets/cosys_car_assets.zip', 'suv_download_tmp\car_assets.zip') }"
         if "%PWSHV7%" == "" (
             %powershell% -command "& { [Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12; iwr https://github.com/Cosys-Lab/Cosys-AirSim/releases/download/carassets/cosys_car_assets.zip -OutFile suv_download_tmp\car_assets.zip }"
         ) else (

diff --git a/build.sh b/build.sh
@@ -144,7 +144,7 @@ echo "=================================================================="
 echo "All environments under Unreal/Environments have been updated."
 echo ""
 echo "For further info see:"
-echo "https://github.com/Microsoft/AirSim/blob/master/docs/build_linux.md"
+echo "https://cosysgit.uantwerpen.be/sensorsimulation/airsim/-/tree/mastermaster/docs/build_linux.md"
 echo "=================================================================="
 
 popd >/dev/null
diff --git a/docs/InfraredCamera.md b/docs/InfraredCamera.md
@@ -1,14 +1,11 @@
-This is a tutorial for generating simulated thermal infrared (IR) images using AirSim and the AirSim Africa environment. 
+This is a tutorial for generating simulated thermal infrared (IR) images using AirSim. 
 
-Pre-compiled Africa Environment can be downloaded from the Releases tab of this Github repo: 
-[Windows Pre-compiled binary](https://github.com/Microsoft/AirSim/releases/tag/v1.2.1)
+To generate your own data, you may use two python files: [create_ir_segmentation_map.py](https://cosysgit.uantwerpen.be/sensorsimulation/airsim/-/tree/master/PythonClient//computer_vision/create_ir_segmentation_map.py) and 
+[capture_ir_segmentation.py](https://cosysgit.uantwerpen.be/sensorsimulation/airsim/-/tree/master/PythonClient//computer_vision/capture_ir_segmentation.py).
 
-To generate your own data, you may use two python files: [create_ir_segmentation_map.py](https://github.com/Microsoft/AirSim/tree/main/PythonClient//computer_vision/create_ir_segmentation_map.py) and 
-[capture_ir_segmentation.py](https://github.com/Microsoft/AirSim/tree/main/PythonClient//computer_vision/capture_ir_segmentation.py).
+[create_ir_segmentation_map.py](https://cosysgit.uantwerpen.be/sensorsimulation/airsim/-/tree/master/PythonClient//computer_vision/create_ir_segmentation_map.py) uses temperature, emissivity, and camera response information to estimate the thermal digital count that could be expected for the objects in the environment, and then reassigns the segmentation IDs in AirSim to match these digital counts. It should be run before starting to capture thermal IR data. Otherwise, digital counts in the IR images will be incorrect. The camera response, temperature, and emissivity data are all included for the Africa environment.
 
-[create_ir_segmentation_map.py](https://github.com/Microsoft/AirSim/tree/main/PythonClient//computer_vision/create_ir_segmentation_map.py) uses temperature, emissivity, and camera response information to estimate the thermal digital count that could be expected for the objects in the environment, and then reassigns the segmentation IDs in AirSim to match these digital counts. It should be run before starting to capture thermal IR data. Otherwise, digital counts in the IR images will be incorrect. The camera response, temperature, and emissivity data are all included for the Africa environment.
-
-[capture_ir_segmentation.py](https://github.com/Microsoft/AirSim/tree/main/PythonClient//computer_vision/capture_ir_segmentation.py) is run after the segmentation IDs have been reassigned. It tracks objects of interest and records the infrared and scene images from the multirotor. It uses Computer Vision mode.
+[capture_ir_segmentation.py](https://cosysgit.uantwerpen.be/sensorsimulation/airsim/-/tree/master/PythonClient//computer_vision/capture_ir_segmentation.py) is run after the segmentation IDs have been reassigned. It tracks objects of interest and records the infrared and scene images from the multirotor. It uses Computer Vision mode.
 
 Finally, the details about how temperatures were estimated for plants and animals in the Africa environment, etc. can be found in this paper:
 

diff --git a/docs/adding_new_apis.md b/docs/adding_new_apis.md
@@ -32,17 +32,17 @@ The APIs use [msgpack-rpc protocol](https://github.com/msgpack-rpc/msgpack-rpc)
 
 To add the RPC code to call the new API, follow the steps below. Follow the implementation of other APIs defined in the files.
 
-1. Add an RPC handler in the server which calls your implemented method in [RpcLibServerBase.cpp](https://github.com/microsoft/AirSim/blob/main/AirLib/src/api/RpcLibServerBase.cpp). Vehicle-specific APIs are in their respective vehicle subfolder.
+1. Add an RPC handler in the server which calls your implemented method in [RpcLibServerBase.cpp](https://cosysgit.uantwerpen.be/sensorsimulation/airsim/-/tree/master/AirLib/src/api/RpcLibServerBase.cpp). Vehicle-specific APIs are in their respective vehicle subfolder.
 
-2. Add the C++ client API method in [RpcClientBase.cpp](https://github.com/microsoft/AirSim/blob/main/AirLib/src/api/RpcLibClientBase.cpp)
+2. Add the C++ client API method in [RpcClientBase.cpp](https://cosysgit.uantwerpen.be/sensorsimulation/airsim/-/tree/master/AirLib/src/api/RpcLibClientBase.cpp)
 
-3. Add the Python client API method in [client.py](https://github.com/microsoft/AirSim/blob/main/PythonClient/airsim/client.py). If needed, add or modify a structure definition in [types.py](https://github.com/microsoft/AirSim/blob/main/PythonClient/airsim/types.py)
+3. Add the Python client API method in [client.py](https://cosysgit.uantwerpen.be/sensorsimulation/airsim/-/tree/master/PythonClient/airsim/client.py). If needed, add or modify a structure definition in [types.py](https://cosysgit.uantwerpen.be/sensorsimulation/airsim/-/tree/master/PythonClient/airsim/types.py)
 
 ## Testing
 
 Testing is required to ensure that the API is working as expected. For this, as expected, you'll have to use the source-built AirSim and Blocks environment. Apart from this, if using the Python APIs, you'll have to use the `airsim` package from source rather than the PyPI package. Below are 2 ways described to go about using the package from source -
 
-1. Use [setup_path.py](https://github.com/microsoft/AirSim/blob/main/PythonClient/multirotor/setup_path.py). It will setup the path such that the local airsim module is used instead of the pip installed package. This is the method used in many of the scripts since the user doesn't need to do anything other than run the script.
+1. Use [setup_path.py](https://cosysgit.uantwerpen.be/sensorsimulation/airsim/-/tree/master/PythonClient/multirotor/setup_path.py). It will setup the path such that the local airsim module is used instead of the pip installed package. This is the method used in many of the scripts since the user doesn't need to do anything other than run the script.
     Place your example script in one of the folders inside `PythonClient` like `multirotor`, `car`, etc. You can also create one to keep things separate, and copy the `setup_path.py` file from another folder.
     Add `import setup_path` before `import airsim` in your files. Now the latest main API (or any branch currently checked out) will be used.