Updated documentation and links

Kokika · Jul 15, 2024 · fb123d4 · fb123d4
1 parent 5e9807f
commit fb123d4
Show file tree

Hide file tree

Showing 57 changed files with 141 additions and 143 deletions.
diff --git a/AirLib/include/common/AirSimSettings.hpp b/AirLib/include/common/AirSimSettings.hpp
@@ -581,7 +581,7 @@ namespace airlib
 
             Settings& settings_json = Settings::singleton();
             //write some settings_json in new file otherwise the string "null" is written if all settings_json are empty
-            settings_json.setString("SeeDocsAt", "https://cosysgit.uantwerpen.be/sensorsimulation/airsim/-/blob/master/docs/settings.md");
+            settings_json.setString("SeeDocsAt", "https://cosys-lab.github.io/settings/");
             settings_json.setDouble("SettingsVersion", 2.0);
 
             std::string settings_filename = Settings::getUserDirectoryFullPath("settings.json");

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -254,7 +254,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://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). 
+* An experimental integration of [AirSim on Unity](https://github.com/Cosys-Lab/Cosys-AirSim/blob/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). 
 * [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
@@ -265,7 +265,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://cosysgit.uantwerpen.be/sensorsimulation/airsim/-/tree/master/PythonClient/airsim/client.py#L137) (works on TalkingHeads binaries in release)
+* [Character Control APIs](https://github.com/Cosys-Lab/Cosys-AirSim/blob/main/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://cosysgit.uantwerpen.be/sensorsimulation/airsim/-/tree/master/docs/settings.md",
+  "SeeDocsAt": "https://cosys-lab.github.io/settings/",
   "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://cosysgit.uantwerpen.be/sensorsimulation/airsim/-/tree/master/docs/settings.md",
+  "SeeDocsAt": "https://cosys-lab.github.io/settings/",
   "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://cosysgit.uantwerpen.be/sensorsimulation/airsim/-/tree/master/docs/gazebo_drone.md).
+This page has moved [here](https://github.com/Cosys-Lab/Cosys-AirSim/blob/main/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://cosysgit.uantwerpen.be/sensorsimulation/airsim/-/tree/master/docs/mavlinkcom_mocap.md).
+This page has moved [here](https://github.com/Cosys-Lab/Cosys-AirSim/blob/main/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://cosysgit.uantwerpen.be/sensorsimulation/airsim/-/tree/master/docs/mavlinkcom.md).
+This page has moved [here](https://github.com/Cosys-Lab/Cosys-AirSim/blob/main/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://cosysgit.uantwerpen.be/sensorsimulation/airsim/-/tree/master/docs/image_apis.md#computer-vision-mode
+# https://github.com/Cosys-Lab/Cosys-AirSim/blob/main/docs/image_apis.md#computer-vision-mode
 
 import setup_path 
 import cosysairsim as 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://cosysgit.uantwerpen.be/sensorsimulation/airsim/-/tree/master/docs/image_apis.md#computer-vision-mode
+# https://github.com/Cosys-Lab/Cosys-AirSim/blob/main/docs/image_apis.md#computer-vision-mode
 
 import setup_path
 import cosysairsim as 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://cosysgit.uantwerpen.be/sensorsimulation/airsim/-/tree/master/docs/image_apis.md#computer-vision-mode
+# https://github.com/Cosys-Lab/Cosys-AirSim/blob/main/docs/image_apis.md#computer-vision-mode
 
 import setup_path 
 import cosysairsim as 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://cosysgit.uantwerpen.be/sensorsimulation/airsim/-/tree/master/docs/image_apis.md#computer-vision-mode
+# https://github.com/Cosys-Lab/Cosys-AirSim/blob/main/docs/image_apis.md#computer-vision-mode
 
 import setup_path 
 import cosysairsim as 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://cosysgit.uantwerpen.be/sensorsimulation/airsim/-/tree/master/docs/image_apis.md#computer-vision-mode
+# https://github.com/Cosys-Lab/Cosys-AirSim/blob/main/docs/image_apis.md#computer-vision-mode
 
 import setup_path 
 import cosysairsim as 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://cosysgit.uantwerpen.be/sensorsimulation/airsim/-/tree/master/docs/image_apis.md#computer-vision-mode
+# https://github.com/Cosys-Lab/Cosys-AirSim/blob/main/docs/image_apis.md#computer-vision-mode
 
 import setup_path 
 import cosysairsim as 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://cosysgit.uantwerpen.be/sensorsimulation/airsim/-/tree/master/docs/image_apis.md#computer-vision-mode
+# https://github.com/Cosys-Lab/Cosys-AirSim/blob/main/docs/image_apis.md#computer-vision-mode
 
 import cosysairsim as 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://cosysgit.uantwerpen.be/sensorsimulation/airsim/-/tree/master/docs/settings.md",
+	"SeeDocsAt": "https://cosys-lab.github.io/settings/",
 	"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://cosysgit.uantwerpen.be/sensorsimulation/airsim/-/tree/master/docs/image_apis.md#computer-vision-mode
+# https://github.com/Cosys-Lab/Cosys-AirSim/blob/main/docs/image_apis.md#computer-vision-mode
 
 import setup_path
 import cosysairsim as airsim

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

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

diff --git a/Unreal/Environments/Blocks/Config/DefaultGame.ini b/Unreal/Environments/Blocks/Config/DefaultGame.ini
@@ -1,12 +1,12 @@
 [/Script/EngineSettings.GeneralProjectSettings]
 ProjectID=367FFC384956CDC4377673B3217F380D
 ProjectName="Blocks"
-CompanyName=Microsoft Research
-Homepage="https://cosysgit.uantwerpen.be/sensorsimulation/airsim"
-SupportContact="https://cosysgit.uantwerpen.be/sensorsimulation/airsim/-/issues"
+CompanyName=Cosys-Lab
+Homepage="https://github.com/Cosys-Lab/Cosys-AirSim"
+SupportContact="https://cosys-lab.github.io/"
 LicensingTerms=MIT Licence
-ProjectDisplayedTitle=NSLOCTEXT("[/Script/EngineSettings]", "8F8B6B2A472F9FDFB69E2B8CFAE8C4E0", "Blocks Environment for AirSim")
-ProjectDebugTitleInfo=NSLOCTEXT("[/Script/EngineSettings]", "F31D7C524A9E9BC66DD2AA922D309408", "Blocks Environment for AirSim")
+ProjectDisplayedTitle=NSLOCTEXT("[/Script/EngineSettings]", "8F8B6B2A472F9FDFB69E2B8CFAE8C4E0", "Blocks Environment for Cosys-AirSim")
+ProjectDebugTitleInfo=NSLOCTEXT("[/Script/EngineSettings]", "F31D7C524A9E9BC66DD2AA922D309408", "Blocks Environment for Cosys-AirSim")
 
 [/Script/UnrealEd.ProjectPackagingSettings]
 Build=IfProjectHasCode

diff --git a/Unreal/Plugins/AirSim/AirSim.uplugin b/Unreal/Plugins/AirSim/AirSim.uplugin
@@ -2,14 +2,14 @@
   "FileVersion" : 3,
   "Version" : "2.0.0",
   "VersionName": "2.0.0",
-  "FriendlyName": "AirSim",
-  "Description": "AirSim - Simulator Plugin",
+  "FriendlyName": "Cosys-AirSim",
+  "Description": "Cosys-AirSim - Simulator Plugin",
   "Category" : "Science",
   "CreatedBy": "Shital Shah",
   "CreatedByURL": "http://cosys-lab.uantwerpen.be/",
-  "DocsURL" : "https://cosysgit.uantwerpen.be/sensorsimulation/airsim/-/blob/master/README.md",
+  "DocsURL" : "https://cosys-lab.github.io/",
   "MarketplaceURL" : "",
-  "SupportURL" : "https://cosysgit.uantwerpen.be/sensorsimulation/airsim/-/blob/master/README.md",
+  "SupportURL" : "https://cosys-lab.github.io/",
   "EnabledByDefault" : true,
   "CanContainContent": true,
   "IsBetaVersion" : true,

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.4.2 and Visual Studio 2022.
     echo Here are few easy steps for upgrade so everything is new and shiny:
-    echo https://cosysgit.uantwerpen.be/sensorsimulation/airsim/-/tree/master/docs/unreal_upgrade.md
+    echo https://github.com/Cosys-Lab/Cosys-AirSim/blob/main/docs/unreal_upgrade.md
     goto :buildfailed_nomsg
 )
 

diff --git a/build.sh b/build.sh
@@ -137,7 +137,7 @@ echo " Cosys-AirSim plugin is built!."
 echo "==============================="
 echo ""
 echo "For further info see for installation see:"
-echo "https://cosysgit.uantwerpen.be/sensorsimulation/airsim/-/tree/mastermaster/docs/install_linux.md"
+echo "https://github.com/Cosys-Lab/Cosys-AirSim/tree/main/docs/install_linux.md"
 echo "=================================================================="
 
 popd >/dev/null
diff --git a/docker/Dockerfile_source b/docker/Dockerfile_source
@@ -13,7 +13,7 @@ RUN echo '%sudo ALL=(ALL) NOPASSWD:ALL' >> /etc/sudoers && \
 
 USER ue4
 RUN cd /home/ue4 && \
-	git clone --progress https://cosysgit.uantwerpen.be/sensorsimulation/airsim.git && \
+	git clone --progress https://github.com/Cosys-Lab/Cosys-AirSim.git && \
 	cd AirSim && \
 	./setup.sh && \
 	./build.sh

diff --git a/docker/settings.json b/docker/settings.json
@@ -1,6 +1,6 @@
 {
-  "SeeDocsAt": "https://cosysgit.uantwerpen.be/sensorsimulation/airsim/-/blob/master/docs/settings.md",
-  "SettingsVersion": 1.2,
+  "SeeDocsAt": "https://cosys-lab.github.io/settings/",
+  "SettingsVersion": 2.0,
   "SimMode": "Multirotor",
   "ClockSpeed": 1.0,
   "Vehicles": {

diff --git a/docs/InfraredCamera.md b/docs/InfraredCamera.md
@@ -1,11 +1,11 @@
 This is a tutorial for generating simulated thermal infrared (IR) images using Cosys-AirSim. 
 
-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/Cosys-Lab/Cosys-AirSim/blob/main/PythonClient/computer_vision/create_ir_segmentation_map.py) and 
+[capture_ir_segmentation.py](https://github.com/Cosys-Lab/Cosys-AirSim/blob/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 Cosys-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/Cosys-Lab/Cosys-AirSim/blob/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 Cosys-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://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.
+[capture_ir_segmentation.py](https://github.com/Cosys-Lab/Cosys-AirSim/blob/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.
 
 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://cosysgit.uantwerpen.be/sensorsimulation/airsim/-/tree/master/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://github.com/Cosys-Lab/Cosys-AirSim/blob/main/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://cosysgit.uantwerpen.be/sensorsimulation/airsim/-/tree/master/AirLib/src/api/RpcLibClientBase.cpp)
+2. Add the C++ client API method in [RpcClientBase.cpp](https://github.com/Cosys-Lab/Cosys-AirSim/blob/main/AirLib/src/api/RpcLibClientBase.cpp)
 
-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)
+3. Add the Python client API method in [client.py](https://github.com/Cosys-Lab/Cosys-AirSim/blob/main/PythonClient/airsim/client.py). If needed, add or modify a structure definition in [types.py](https://github.com/Cosys-Lab/Cosys-AirSim/blob/main/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://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.
+1. Use [setup_path.py](https://github.com/Cosys-Lab/Cosys-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.
     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 cosysairsim as airsim` in your files. Now the latest main API (or any branch currently checked out) will be used.