From 4cc35d8b2fc40527787af5215c1a772980909933 Mon Sep 17 00:00:00 2001 From: wojansen Date: Tue, 10 Mar 2020 19:47:11 +0100 Subject: [PATCH] Updated links in documentation --- AirLib/include/common/AirSimSettings.hpp | 2 +- CHANGELOG.md | 6 +++--- Examples/DataCollection/DataCollectorSGM_settings.json | 2 +- Examples/DepthNav/DepthNav_settings.json | 2 +- PythonClient/README.md | 2 +- PythonClient/airsim/client.py | 2 +- PythonClient/computer_vision/character_control.py | 2 +- PythonClient/computer_vision/cv_capture.py | 2 +- PythonClient/computer_vision/cv_mode.py | 2 +- PythonClient/computer_vision/cv_navigate.py | 2 +- PythonClient/computer_vision/getpos.py | 2 +- PythonClient/computer_vision/ground_truth.py | 2 +- PythonClient/computer_vision/objects.py | 2 +- PythonClient/computer_vision/segmentation.py | 2 +- PythonClient/multirotor/multi_agent_drone.py | 2 +- PythonClient/multirotor/opencv_show.py | 2 +- README.md | 2 +- Unreal/Plugins/AirSim/AirSim.uplugin | 8 ++++---- build.cmd | 2 +- build.sh | 4 ++-- cmake/build.sh | 2 +- cmake/gcc_build.sh | 2 +- docker/settings.json | 2 +- docs/apis.md | 4 ++-- docs/apis_cpp.md | 4 ++-- docs/build_linux.md | 2 +- docs/custom_drone.md | 2 +- docs/docker_ubuntu.md | 8 ++++---- docs/gpulidar.md | 2 +- docs/lidar.md | 2 +- docs/mkdocs.yml | 8 +++----- docs/pfm.md | 2 +- docs/sensors.md | 2 +- docs/settings.md | 2 +- docs/unreal_custenv.md | 2 +- docs/unreal_upgrade.md | 2 +- ros/cplusplus_ws/src/airsim_tutorial_pkgs/README.md | 8 ++++---- .../scripts/multi_drone_json_creator.py | 2 +- .../settings/front_stereo_and_center_mono.json | 2 +- .../airsim_tutorial_pkgs/settings/twenty_five_drones.json | 2 +- .../settings/two_drones_camera_lidar_imu.json | 2 +- ros/python_ws/src/airsim/scripts/airsimpy/client.py | 2 +- setup.sh | 2 +- 43 files changed, 59 insertions(+), 61 deletions(-) diff --git a/AirLib/include/common/AirSimSettings.hpp b/AirLib/include/common/AirSimSettings.hpp index c73ef37b6..4b08bbf3b 100644 --- a/AirLib/include/common/AirSimSettings.hpp +++ b/AirLib/include/common/AirSimSettings.hpp @@ -461,7 +461,7 @@ struct AirSimSettings { std::string settings_filename = Settings::getUserDirectoryFullPath("settings.json"); Settings& settings_json = Settings::loadJSonString("{}"); //write some settings_json in new file otherwise the string "null" is written if all settings_json are empty - settings_json.setString("SeeDocsAt", "https://github.com/Microsoft/AirSim/blob/master/docs/settings.md"); + settings_json.setString("SeeDocsAt", "https://cosysgit.uantwerpen.be/sensorsimulation/airsim/-/blob/master/docs/settings.md"); settings_json.setDouble("SettingsVersion", 1.2); //TODO: there is a crash in Linux due to settings_json.saveJSonString(). Remove this workaround after we only support Unreal 4.17 diff --git a/CHANGELOG.md b/CHANGELOG.md index 120bbee83..03a103cc1 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,6 +1,6 @@ # What's new -Below is summarized list of important changes. This does not include minor/less important changes or bug fixes or documentation update. This list updated every few months. For complete detailed changes, please review [commit history](https://github.com/Microsoft/AirSim/commits/master). +Below is summarized list of important changes. This does not include minor/less important changes or bug fixes or documentation update. This list updated every few months. For complete detailed changes, please review [commit history](https://cosysgit.uantwerpen.be/sensorsimulation/airsim/-/commits/master). ### CoSys-Lab Modifications * Updated [ROS implementation](docs/ros.md) @@ -26,7 +26,7 @@ Below is summarized list of important changes. This does not include minor/less * Added [Time of Day API](docs/apis.md#time-of-day-api) * An experimental integration of [AirSim on Unity](https://github.com/Microsoft/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](https://github.com/Microsoft/AirSim/blob/master/docs/settings.md#viewmode) to turn off main screen rendering so you can capture images at high rate +* Highly efficient [NoDisplay view mode](https://cosysgit.uantwerpen.be/sensorsimulation/airsim/-/blob/master/docs/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 * [Lidar Sensor](docs/lidar.md) * [Support for Flysky FS-SM100 RC](https://github.com/Microsoft/AirSim/commit/474214364676b6631c01b3ed79d00c83ba5bccf5) USB adapter @@ -35,7 +35,7 @@ Below is summarized list of important changes. This does not include minor/less * [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/master/PythonClient/airsim/client.py#L137) (works on TalkingHeads binaries in release) +* [Character Control APIs](https://cosysgit.uantwerpen.be/sensorsimulation/airsim/-/blob/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 index 47002ea8a..a4a17ad2f 100644 --- a/Examples/DataCollection/DataCollectorSGM_settings.json +++ b/Examples/DataCollection/DataCollectorSGM_settings.json @@ -1,5 +1,5 @@ { - "SeeDocsAt": "https://github.com/Microsoft/AirSim/blob/master/docs/settings.md", + "SeeDocsAt": "https://cosysgit.uantwerpen.be/sensorsimulation/airsim/-/blob/master/docs/settings.md", "SettingsVersion": 1.2, "SimMode": "ComputerVision", "CameraDefaults": { diff --git a/Examples/DepthNav/DepthNav_settings.json b/Examples/DepthNav/DepthNav_settings.json index 686f69734..57a13d385 100644 --- a/Examples/DepthNav/DepthNav_settings.json +++ b/Examples/DepthNav/DepthNav_settings.json @@ -1,5 +1,5 @@ { - "SeeDocsAt": "https://github.com/Microsoft/AirSim/blob/master/docs/settings.md", + "SeeDocsAt": "https://cosysgit.uantwerpen.be/sensorsimulation/airsim/-/blob/master/docs/settings.md", "SettingsVersion": 1.2, "SimMode": "ComputerVision", "CameraDefaults": { diff --git a/PythonClient/README.md b/PythonClient/README.md index 4be67d887..9f092988b 100644 --- a/PythonClient/README.md +++ b/PythonClient/README.md @@ -18,5 +18,5 @@ Some examples also requires opencv. ## More Info More information on AirSim Python APIs can be found at: -https://github.com/Microsoft/AirSim/blob/master/docs/python.md +https://cosysgit.uantwerpen.be/sensorsimulation/airsim/-/blob/master/docs/python.md diff --git a/PythonClient/airsim/client.py b/PythonClient/airsim/client.py index 4995ffb80..4e600ac61 100644 --- a/PythonClient/airsim/client.py +++ b/PythonClient/airsim/client.py @@ -254,7 +254,7 @@ def waitOnLastTask(timeout_sec = float('nan')): # legacy handling # TODO: remove below legacy wrappers in future major releases - upgrade_api_help = "\nPlease see https://github.com/Microsoft/AirSim/blob/master/docs/upgrade_apis.md for more info." + upgrade_api_help = "\nPlease see https://cosysgit.uantwerpen.be/sensorsimulation/airsim/-/blob/master/docs/upgrade_apis.md for more info." def simGetPose(self): logging.warning("simGetPose API is renamed to simGetVehiclePose. Please update your code." + self.upgrade_api_help) return self.simGetVehiclePose() diff --git a/PythonClient/computer_vision/character_control.py b/PythonClient/computer_vision/character_control.py index 81cf8c6ed..89d2dea22 100644 --- a/PythonClient/computer_vision/character_control.py +++ b/PythonClient/computer_vision/character_control.py @@ -1,6 +1,6 @@ # This script expects object available in UE environment of type AAirSimCharater # In settings.json first activate computer vision mode: -# https://github.com/Microsoft/AirSim/blob/master/docs/image_apis.md#computer-vision-mode +# https://cosysgit.uantwerpen.be/sensorsimulation/airsim/-/blob/master/docs/image_apis.md#computer-vision-mode import setup_path import airsim diff --git a/PythonClient/computer_vision/cv_capture.py b/PythonClient/computer_vision/cv_capture.py index 1ee625f82..a855dd4ad 100644 --- 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/master/docs/image_apis.md#computer-vision-mode +# https://cosysgit.uantwerpen.be/sensorsimulation/airsim/-/blob/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 index 188080ba2..872fcebe0 100644 --- 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/master/docs/image_apis.md#computer-vision-mode +# https://cosysgit.uantwerpen.be/sensorsimulation/airsim/-/blob/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 index 1fb01b6e9..f31c990e5 100644 --- 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/master/docs/image_apis.md#computer-vision-mode +# https://cosysgit.uantwerpen.be/sensorsimulation/airsim/-/blob/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 index 8304d429e..2bbbd1846 100644 --- 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/master/docs/image_apis.md#computer-vision-mode +# https://cosysgit.uantwerpen.be/sensorsimulation/airsim/-/blob/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 index 5e04f1262..ac77b3dcd 100644 --- 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/master/docs/image_apis.md#computer-vision-mode +# https://cosysgit.uantwerpen.be/sensorsimulation/airsim/-/blob/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 index 09f61831c..f20304a62 100644 --- 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/master/docs/image_apis.md#computer-vision-mode +# https://cosysgit.uantwerpen.be/sensorsimulation/airsim/-/blob/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 index 520dfa027..e8299b451 100644 --- 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/master/docs/image_apis.md#computer-vision-mode +# https://cosysgit.uantwerpen.be/sensorsimulation/airsim/-/blob/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 index bfd044c3f..b3d2b0530 100644 --- 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/master/docs/settings.md", + "SeeDocsAt": "https://cosysgit.uantwerpen.be/sensorsimulation/airsim/-/blob/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 index 58f8d50e3..115128e7f 100644 --- 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/master/docs/image_apis.md#computer-vision-mode +# https://cosysgit.uantwerpen.be/sensorsimulation/airsim/-/blob/master/docs/image_apis.md#computer-vision-mode import setup_path import airsim diff --git a/README.md b/README.md index 93ccee1e1..76e0e6a6f 100644 --- a/README.md +++ b/README.md @@ -34,7 +34,7 @@ Cars in AirSim * Updated Unreal to 4.22 ## What's New -* A ROS wrapper for multirotors is available. See [airsim_ros_pkgs](https://github.com/microsoft/AirSim/blob/master/ros/src/airsim_ros_pkgs) for the ROS API, and [airsim_tutorial_pkgs](https://github.com/microsoft/AirSim/blob/master/ros/src/airsim_tutorial_pkgs) for tutorials. +* A ROS wrapper for multirotors is available. See [airsim_ros_pkgs](https://cosysgit.uantwerpen.be/sensorsimulation/airsim/-/blob/master/ros/src/airsim_ros_pkgs) for the ROS API, and [airsim_tutorial_pkgs](https://cosysgit.uantwerpen.be/sensorsimulation/airsim/-/blob/master/ros/src/airsim_tutorial_pkgs) for tutorials. * [Added sensor APIs for Barometer, IMU, GPS, Magnetometer, Distance Sensor](docs/sensors.md) * Added support for [docker in ubuntu](docs/docker_ubuntu) * Added Weather Effects and [APIs](docs/apis#weather-apis) diff --git a/Unreal/Plugins/AirSim/AirSim.uplugin b/Unreal/Plugins/AirSim/AirSim.uplugin index a467e4187..738414396 100644 --- a/Unreal/Plugins/AirSim/AirSim.uplugin +++ b/Unreal/Plugins/AirSim/AirSim.uplugin @@ -3,13 +3,13 @@ "Version" : "1.2.0", "VersionName": "1.2.0", "FriendlyName": "AirSim", - "Description": "AirSim - Autonomous Aerial Vehicles Simulator Plugin", + "Description": "AirSim - Simulator Plugin", "Category" : "Science", "CreatedBy": "Shital Shah", - "CreatedByURL": "http://github.com/Microsoft/AirSim", - "DocsURL" : "https://github.com/Microsoft/AirSim/blob/master/README.md", + "CreatedByURL": "http://cosys-lab.uantwerpen.be/", + "DocsURL" : "https://cosysgit.uantwerpen.be/sensorsimulation/airsim/-/blob/master/README.md", "MarketplaceURL" : "", - "SupportURL" : "https://github.com/Microsoft/AirSim/issues", + "SupportURL" : "https://cosysgit.uantwerpen.be/sensorsimulation/airsim/-/blob/master/README.md", "EnabledByDefault" : true, "CanContainContent": true, "IsBetaVersion" : true, diff --git a/build.cmd b/build.cmd index c35b36966..4eb41215b 100644 --- a/build.cmd +++ b/build.cmd @@ -17,7 +17,7 @@ if "%VisualStudioVersion%"=="14.0" ( echo( echo Hello there! We just upgraded AirSim to Unreal Engine 4.22 and Visual Studio 2017. echo Here are few easy steps for upgrade so everything is new and shiny: - echo https://github.com/Microsoft/AirSim/blob/master/docs/unreal_upgrade.md + echo https://cosysgit.uantwerpen.be/sensorsimulation/airsim/-/blob/master/docs/unreal_upgrade.md goto :buildfailed_nomsg ) diff --git a/build.sh b/build.sh index 865a229fa..10274e519 100755 --- a/build.sh +++ b/build.sh @@ -12,7 +12,7 @@ if [[ ! -d "llvm-source-50" ]]; then if [[ -d "llvm-source-39" ]]; then echo "Hello there! We just upgraded AirSim to Unreal Engine 4.22." echo "Here are few easy steps for upgrade so everything is new and shiny :)" - echo "https://github.com/Microsoft/AirSim/blob/master/docs/unreal_upgrade.md" + echo "https://cosysgit.uantwerpen.be/sensorsimulation/airsim/-/blob/master/docs/unreal_upgrade.md" exit 1 else echo "The llvm-souce-50 folder was not found! Mystery indeed." @@ -125,7 +125,7 @@ echo "If you are using your own environment, update plugin using," echo "rsync -a --delete Unreal/Plugins path/to/MyUnrealProject" echo "" echo "For help see:" -echo "https://github.com/Microsoft/AirSim/blob/master/docs/build_linux.md" +echo "https://cosysgit.uantwerpen.be/sensorsimulation/airsim/-/blob/master/docs/build_linux.md" echo "==================================================================" diff --git a/cmake/build.sh b/cmake/build.sh index 42a26f219..34f561895 100755 --- a/cmake/build.sh +++ b/cmake/build.sh @@ -2,7 +2,7 @@ # You should NOT use this with Unreal. # If you want bits that work in Unreal you need to use ../build.sh # For pre-requisite tools needed to run this script see -# https://github.com/Microsoft/AirSim/blob/master/docs/build_linux.md +# https://cosysgit.uantwerpen.be/sensorsimulation/airsim/-/blob/master/docs/build_linux.md # First get the location of this script, it is assumed you already cloned "main" and you are running the # script from that repo. It will then put everything else in a ROS workspace at "../catkin_ws" diff --git a/cmake/gcc_build.sh b/cmake/gcc_build.sh index 1cb6b1c93..b75ad836b 100644 --- a/cmake/gcc_build.sh +++ b/cmake/gcc_build.sh @@ -2,7 +2,7 @@ # You should NOT use this with Unreal. # If you want bits that work in Unreal you need to use ../build.sh # For pre-requisite tools needed to run this script see -# https://github.com/Microsoft/AirSim/blob/master/docs/build_linux.md +# https://cosysgit.uantwerpen.be/sensorsimulation/airsim/-/blob/master/docs/build_linux.md # First get the location of this script, it is assumed you already cloned "main" and you are running the # script from that repo. It will then put everything else in a ROS workspace at "../catkin_ws" diff --git a/docker/settings.json b/docker/settings.json index 8d6457324..695707d9b 100644 --- a/docker/settings.json +++ b/docker/settings.json @@ -1,5 +1,5 @@ { - "SeeDocsAt": "https://github.com/Microsoft/AirSim/blob/master/docs/settings_json.md", + "SeeDocsAt": "https://cosysgit.uantwerpen.be/sensorsimulation/airsim/-/blob/master/docs/settings.md", "SettingsVersion": 1.2, "SimMode": "Multirotor", "ClockSpeed": 1.0, diff --git a/docs/apis.md b/docs/apis.md index 866ee3637..002dd639a 100644 --- a/docs/apis.md +++ b/docs/apis.md @@ -136,7 +136,7 @@ AirSim allows to pause and continue the simulation through `pause(is_paused)` AP The collision information can be obtained using `simGetCollisionInfo` API. This call returns a struct that has information not only whether collision occurred but also collision position, surface normal, penetration depth and so on. ### Time of Day API -AirSim assumes there exist sky sphere of class `EngineSky/BP_Sky_Sphere` in your environment with [ADirectionalLight actor](https://github.com/Microsoft/AirSim/blob/master/Unreal/Plugins/AirSim/Source/SimMode/SimModeBase.cpp#L156). By default, the position of the sun in the scene doesn't move with time. You can use [settings](settings.md#timeofday) to set up latitude, longitude, date and time which AirSim uses to compute the position of sun in the scene. +AirSim assumes there exist sky sphere of class `EngineSky/BP_Sky_Sphere` in your environment with [ADirectionalLight actor](https://cosysgit.uantwerpen.be/sensorsimulation/airsim/-/blob/master/Unreal/Plugins/AirSim/Source/SimMode/SimModeBase.cpp#L156). By default, the position of the sun in the scene doesn't move with time. You can use [settings](settings.md#timeofday) to set up latitude, longitude, date and time which AirSim uses to compute the position of sun in the scene. You can also use following API call to set the sun position according to given date time: @@ -176,7 +176,7 @@ class WeatherParameter: Please note that `Roadwetness`, `RoadSnow` and `RoadLeaf` effects requires adding [materials](https://github.com/Microsoft/AirSim/tree/master/Unreal/Plugins/AirSim/Content/Weather/WeatherFX) to your scene. -Please see [example code](https://github.com/Microsoft/AirSim/blob/master/PythonClient/computer_vision/weather.py) for more details. +Please see [example code](https://cosysgit.uantwerpen.be/sensorsimulation/airsim/-/blob/master/PythonClient/computer_vision/weather.py) for more details. ### Lidar APIs AirSim offers API to retrieve point cloud data from Lidar sensors on vehicles. You can set the number of channels, points per second, horizontal and vertical FOV, etc parameters in [settings.json](settings.md). diff --git a/docs/apis_cpp.md b/docs/apis_cpp.md index 3a01d5444..141f9cb4a 100644 --- a/docs/apis_cpp.md +++ b/docs/apis_cpp.md @@ -16,7 +16,7 @@ Here's how to use AirSim APIs using Python to control simulated car (see also [P ```cpp -// ready to run example: https://github.com/Microsoft/AirSim/blob/master/HelloCar/main.cpp +// ready to run example: https://cosysgit.uantwerpen.be/sensorsimulation/airsim/-/blob/master/HelloCar/main.cpp #include #include "vehicles/car/api/CarRpcLibClient.hpp" @@ -54,7 +54,7 @@ Here's how to use AirSim APIs using Python to control simulated car (see also [P ```cpp -// ready to run example: https://github.com/Microsoft/AirSim/blob/master/HelloDrone/main.cpp +// ready to run example: https://cosysgit.uantwerpen.be/sensorsimulation/airsim/-/blob/master/HelloDrone/main.cpp #include #include "vehicles/multirotor/api/MultirotorRpcLibClient.hpp" diff --git a/docs/build_linux.md b/docs/build_linux.md index 916115707..11d7bb944 100644 --- a/docs/build_linux.md +++ b/docs/build_linux.md @@ -5,7 +5,7 @@ The current recommended and tested environment is **Ubuntu 16.04 LTS**. Theoreti We've two options - you can either build inside docker containers or your host machine. ## Docker -Please see instructions [here](https://github.com/Microsoft/AirSim/blob/master/docs/docker_ubuntu.md) +Please see instructions [here](https://cosysgit.uantwerpen.be/sensorsimulation/airsim/-/blob/master/docs/docker_ubuntu.md) ## Host machine diff --git a/docs/custom_drone.md b/docs/custom_drone.md index 1647d45b9..f58775a03 100644 --- a/docs/custom_drone.md +++ b/docs/custom_drone.md @@ -62,7 +62,7 @@ You can run the MavlinkCom library and MavLinkTest app to test the connection between your companion computer and flight controller. ## How Does This Work? -AirSim uses MavLinkCom component developed by @lovettchris. The MavLinkCom has a proxy architecture where you can open a connection to PX4 either using serial or UDP and then other components share this connection. When PX4 sends MavLink message, all components receive that message. If any component sends a message then it's received by PX4 only. This allows you to connect any number of components to PX4 [This code](https://github.com/Microsoft/AirSim/blob/master/AirLib/include/vehicles/multirotor/controllers/MavLinkDroneController.hpp#L793) opens a connection for LogViewer and QGC. You can add something more if you like. +AirSim uses MavLinkCom component developed by @lovettchris. The MavLinkCom has a proxy architecture where you can open a connection to PX4 either using serial or UDP and then other components share this connection. When PX4 sends MavLink message, all components receive that message. If any component sends a message then it's received by PX4 only. This allows you to connect any number of components to PX4 [This code](https://cosysgit.uantwerpen.be/sensorsimulation/airsim/-/blob/master/AirLib/include/vehicles/multirotor/controllers/MavLinkDroneController.hpp#L793) opens a connection for LogViewer and QGC. You can add something more if you like. If you want to use QGC + AirSim together than you will need QGC to let own the serial port. QGC opens up TCP connection that acts as a proxy so any other component can connect to QGC and send MavLinkMessage to QGC and then QGC forwards that message to PX4. So you tell AirSim to connect to QGC and let QGC own serial port. diff --git a/docs/docker_ubuntu.md b/docs/docker_ubuntu.md index b7c1fe564..4b272a911 100644 --- a/docs/docker_ubuntu.md +++ b/docs/docker_ubuntu.md @@ -47,7 +47,7 @@ You can download it by running ``` $ ./run_airsim_image_binary.sh Blocks/Blocks.sh -- headless ``` -- [Specifying a `settings.json`](https://github.com/Microsoft/AirSim/blob/master/docs/docker_ubuntu.md#airsim_binary-docker-image) +- [Specifying a `settings.json`](https://cosysgit.uantwerpen.be/sensorsimulation/airsim/-/blob/master/docs/docker_ubuntu.md#airsim_binary-docker-image) ## Source #### Requirements: @@ -97,7 +97,7 @@ You can download it by running * Inside the container, you can see `UnrealEngine` and `AirSim` under `/home/ue4`. * Start unreal engine inside the container: `ue4@HOSTMACHINE:~$ /home/ue4/UnrealEngine/Engine/Binaries/Linux/UE4Editor` -* [Specifying an airsim settings.json](https://github.com/Microsoft/AirSim/blob/master/docs/docker_ubuntu.md#airsim_source-docker-image) +* [Specifying an airsim settings.json](https://cosysgit.uantwerpen.be/sensorsimulation/airsim/-/blob/master/docs/docker_ubuntu.md#airsim_source-docker-image) * Continue with [AirSim's Linux docs](build_linux.md). #### [Misc] Packaging Unreal Environments in `airsim_source` containers @@ -115,7 +115,7 @@ You can download it by running ### Specifying an airsim settings.json #### `airsim_binary` docker image: - We're mapping the host machine's `PATH/TO/Airsim/docker/settings.json` to the docker container's `/home/airsim_user/Documents/AirSim/settings.json`. - - Hence, we can load any settings file by simply modifying `PATH_TO_YOUR/settings.json` by modifying the following snippets in * [`run_airsim_image_binary.sh`](https://github.com/Microsoft/AirSim/blob/master/docker/run_airsim_image_binary.sh) + - Hence, we can load any settings file by simply modifying `PATH_TO_YOUR/settings.json` by modifying the following snippets in * [`run_airsim_image_binary.sh`](https://cosysgit.uantwerpen.be/sensorsimulation/airsim/-/blob/master/docker/run_airsim_image_binary.sh) ``` nvidia-docker run -it \ -v $PATH_TO_YOUR/settings.json:/home/airsim_user/Documents/AirSim/settings.json \ @@ -136,7 +136,7 @@ You can download it by running #### `airsim_source` docker image: * We're mapping the host machine's `PATH/TO/Airsim/docker/settings.json` to the docker container's `/home/airsim_user/Documents/AirSim/settings.json`. - * Hence, we can load any settings file by simply modifying `PATH_TO_YOUR/settings.json` by modifying the following snippets in [`run_airsim_image_source.sh`](https://github.com/Microsoft/AirSim/blob/master/docker/run_airsim_image_source.sh): + * Hence, we can load any settings file by simply modifying `PATH_TO_YOUR/settings.json` by modifying the following snippets in [`run_airsim_image_source.sh`](https://cosysgit.uantwerpen.be/sensorsimulation/airsim/-/blob/master/docker/run_airsim_image_source.sh): ``` nvidia-docker run -it \ -v $(pwd)/settings.json:/home/airsim_user/Documents/AirSim/settings.json \ diff --git a/docs/gpulidar.md b/docs/gpulidar.md index a2dbb2377..887a59920 100644 --- a/docs/gpulidar.md +++ b/docs/gpulidar.md @@ -39,7 +39,7 @@ NoiseDistanceScale | To scale the noise with distance, set this parameter IgnoreMarked | Remove objects with the Unreal Tag _MarkedIgnore_ from the sensor data ``` { - "SeeDocsAt": "https://github.com/Microsoft/AirSim/blob/master/docs/settings_json.md", + "SeeDocsAt": "https://cosysgit.uantwerpen.be/sensorsimulation/airsim/-/blob/master/docs/settings.md", "SettingsVersion": 1.2, "SimMode": "Multirotor", diff --git a/docs/lidar.md b/docs/lidar.md index df70488de..6ccda9dac 100644 --- a/docs/lidar.md +++ b/docs/lidar.md @@ -40,7 +40,7 @@ MinNoiseStandardDeviation | The standard deviation to generate the noise normal NoiseDistanceScale | To scale the noise with distance, set this parameter. This way the minimal noise is scaled depending on the distance compared to total maximum range of the sensor ``` { - "SeeDocsAt": "https://github.com/Microsoft/AirSim/blob/master/docs/settings_json.md", + "SeeDocsAt": "https://cosysgit.uantwerpen.be/sensorsimulation/airsim/-/blob/master/docs/settings.md", "SettingsVersion": 1.2, "SimMode": "Multirotor", diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index 0137ec721..458a72d83 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -3,8 +3,8 @@ strict: true site_name: AirSim site_dir: build docs_dir: doc_root -repo_url: https://github.com/microsoft/airsim -#site_url: http://microsoft.github.io/airsim +repo_url: https://cosysgit.uantwerpen.be/sensorsimulation/airsim/ +#site_url: https://cosysgit.uantwerpen.be/sensorsimulation/airsim/ #edit_uri: edit/master/docs #repo_name: GitHub site_description: 'Open source simulator based on Unreal Engine for autonomous vehicles from Microsoft AI & Research' @@ -94,10 +94,8 @@ extra: #fonttext: 'Ubuntu' #fontcode: 'Ubuntu Mono' social: - - type: facebook - link: https://www.facebook.com/groups/1225832467530667/ - type: github-alt - link: https://github.com/Microsoft/AirSim + link: https://cosysgit.uantwerpen.be/sensorsimulation/airsim/ # - type: twitter # link: https://twitter.com/hashtag/abinit # - type: youtube diff --git a/docs/pfm.md b/docs/pfm.md index f6cd54af2..cf3100622 100644 --- a/docs/pfm.md +++ b/docs/pfm.md @@ -4,4 +4,4 @@ Pfm (or Portable FloatMap) image format stores image as floating point pixels an One of the good viewer to view this file format is [PfmPad](https://sourceforge.net/projects/pfmpad/). We don't recommend Maverick photo viewer because it doesn't seem to show depth images properly. -AirSim has code to write pfm file for [C++](https://github.com/Microsoft/AirSim/blob/master/AirLib/include/common/common_utils/Utils.hpp#L637) and read as well as write for [Python](https://github.com/Microsoft/AirSim/tree/master/PythonClient//airsim/utils.py#L122). +AirSim has code to write pfm file for [C++](https://cosysgit.uantwerpen.be/sensorsimulation/airsim/-/blob/master/AirLib/include/common/common_utils/Utils.hpp#L637) and read as well as write for [Python](https://github.com/Microsoft/AirSim/tree/master/PythonClient//airsim/utils.py#L122). diff --git a/docs/sensors.md b/docs/sensors.md index a9f26ef9d..d3e9a59e2 100644 --- a/docs/sensors.md +++ b/docs/sensors.md @@ -31,7 +31,7 @@ If no sensors are specified in the `settings json`, the the following sensors ar ### ComputerVision * None -Behind the scenes, 'createDefaultSensorSettings' method in [AirSimSettings.hpp](https://github.com/Microsoft/AirSim/blob/master/AirLib/include/common/AirSimSettings.hpp) which sets up the above sensors with their default parameters, depending on the sim mode specified in the `settings.json` file. +Behind the scenes, 'createDefaultSensorSettings' method in [AirSimSettings.hpp](https://cosysgit.uantwerpen.be/sensorsimulation/airsim/-/blob/master/AirLib/include/common/AirSimSettings.hpp) which sets up the above sensors with their default parameters, depending on the sim mode specified in the `settings.json` file. ## Configuring the default sensor list diff --git a/docs/settings.md b/docs/settings.md index d57a70cab..8b000396d 100644 --- a/docs/settings.md +++ b/docs/settings.md @@ -220,7 +220,7 @@ To disable the rendering of certain objects on specific cameras or all, use the For explanation of other settings, please see [this article](https://docs.unrealengine.com/latest/INT/Engine/Rendering/PostProcessEffects/AutomaticExposure/). ### NoiseSettings -The `NoiseSettings` allows to add noise to the specified image type with a goal of simulating camera sensor noise, interference and other artifacts. By default no noise is added, i.e., `Enabled: false`. If you set `Enabled: true` then following different types of noise and interference artifacts are enabled, each can be further tuned using setting. The noise effects are implemented as shader created as post processing material in Unreal Engine called [CameraSensorNoise](https://github.com/Microsoft/AirSim/blob/master/Unreal/Plugins/AirSim/Content/HUDAssets/CameraSensorNoise.uasset). +The `NoiseSettings` allows to add noise to the specified image type with a goal of simulating camera sensor noise, interference and other artifacts. By default no noise is added, i.e., `Enabled: false`. If you set `Enabled: true` then following different types of noise and interference artifacts are enabled, each can be further tuned using setting. The noise effects are implemented as shader created as post processing material in Unreal Engine called [CameraSensorNoise](https://cosysgit.uantwerpen.be/sensorsimulation/airsim/-/blob/master/Unreal/Plugins/AirSim/Content/HUDAssets/CameraSensorNoise.uasset). Demo of camera noise and interference simulation: diff --git a/docs/unreal_custenv.md b/docs/unreal_custenv.md index 323ecc190..d4d70f99a 100644 --- a/docs/unreal_custenv.md +++ b/docs/unreal_custenv.md @@ -82,7 +82,7 @@ By default AirSim prompts user for which vehicle to use. You can easily change t ## Updating Your Environment to Latest Version of AirSim Once you have your environment using above instructions, you should frequently update your local AirSim code to latest version from GitHub. Below are the instructions to do this: -1. First put [clean.bat](https://github.com/Microsoft/AirSim/blob/master/Unreal/Environments/Blocks/clean.bat) (or [clean.sh](https://github.com/Microsoft/AirSim/blob/master/Unreal/Environments/Blocks/clean.sh) for Linux users) in the root folder of your environment. Run this file to clean up all intermediate files in your Unreal project. +1. First put [clean.bat](https://cosysgit.uantwerpen.be/sensorsimulation/airsim/-/blob/master/Unreal/Environments/Blocks/clean.bat) (or [clean.sh](https://cosysgit.uantwerpen.be/sensorsimulation/airsim/-/blob/master/Unreal/Environments/Blocks/clean.sh) for Linux users) in the root folder of your environment. Run this file to clean up all intermediate files in your Unreal project. 2. Do `git pull` in your AirSim repo followed by `build.cmd` (or `./build.sh` for Linux users). 3. Replace [your project]/Plugins folder with AirSim/Unreal/Plugins folder. 4. Right click on your .uproject file and chose "Generate Visual Studio project files" option. This is not required for Linux. diff --git a/docs/unreal_upgrade.md b/docs/unreal_upgrade.md index 9a8d9f310..8b84afb8b 100644 --- a/docs/unreal_upgrade.md +++ b/docs/unreal_upgrade.md @@ -15,7 +15,7 @@ These instructions apply if you are already using AirSim on Unreal Engine 4.16. ### For Linux Users 1. From your AirSim repo folder, run 'clean_rebuild.sh`. 2. Rename or delete your existing folder for Unreal Engine. -3. Follow step 1 and 2 to [install Unreal Engine 4.22](https://github.com/Microsoft/AirSim/blob/master/docs/build_linux.md#install-and-build). +3. Follow step 1 and 2 to [install Unreal Engine 4.22](https://cosysgit.uantwerpen.be/sensorsimulation/airsim/-/blob/master/docs/build_linux.md#install-and-build). ## Upgrading Your Custom Unreal Project If you have your own Unreal project created in an older version of Unreal Engine then you need to upgrade your project to Unreal 4.22. To do this, diff --git a/ros/cplusplus_ws/src/airsim_tutorial_pkgs/README.md b/ros/cplusplus_ws/src/airsim_tutorial_pkgs/README.md index 340983e0e..0da61d0a1 100644 --- a/ros/cplusplus_ws/src/airsim_tutorial_pkgs/README.md +++ b/ros/cplusplus_ws/src/airsim_tutorial_pkgs/README.md @@ -1,7 +1,7 @@ # AirSim ROS Tutorials This is a set of sample AirSim `settings.json`s, roslaunch and rviz files to give a starting point for using AirSim with ROS. -See [airsim_ros_pkgs](https://github.com/microsoft/AirSim/blob/master/ros/src/airsim_ros_pkgs/README.md) for the ROS API. +See [airsim_ros_pkgs](https://cosysgit.uantwerpen.be/sensorsimulation/airsim/-/blob/master/ros/src/airsim_ros_pkgs/README.md) for the ROS API. ## Setup @@ -13,7 +13,7 @@ $ catkin build airsim_tutorial_pkgs ## Examples ### Single drone with monocular and depth cameras, and lidar - - Settings.json - [front_stereo_and_center_mono.json](https://github.com/microsoft/AirSim/blob/master/ros/src/airsim_tutorial_pkgs/settings/front_stereo_and_center_mono.json) + - Settings.json - [front_stereo_and_center_mono.json](https://cosysgit.uantwerpen.be/sensorsimulation/airsim/-/blob/master/ros/src/airsim_tutorial_pkgs/settings/front_stereo_and_center_mono.json) ```shell $ source PATH_TO/AirSim/ros/devel/setup.bash $ roscd airsim_tutorial_pkgs @@ -30,7 +30,7 @@ $ catkin build airsim_tutorial_pkgs ### Two drones, with cameras, lidar, IMU each -- Settings.json - [two_drones_camera_lidar_imu.json](https://github.com/microsoft/AirSim/blob/master/ros/src/airsim_tutorial_pkgs/settings/two_drones_camera_lidar_imu.json) +- Settings.json - [two_drones_camera_lidar_imu.json](https://cosysgit.uantwerpen.be/sensorsimulation/airsim/-/blob/master/ros/src/airsim_tutorial_pkgs/settings/two_drones_camera_lidar_imu.json) ```shell $ source PATH_TO/AirSim/ros/devel/setup.bash @@ -45,7 +45,7 @@ $ catkin build airsim_tutorial_pkgs You can view the tfs in rviz. And do a `rostopic list` and `rosservice list` to inspect the services avaiable. ### Twenty-five drones in a square pattern -- Settings.json - [twenty_five_drones.json](https://github.com/microsoft/AirSim/blob/master/ros/src/airsim_tutorial_pkgs/settings/twenty_five_drones.json) +- Settings.json - [twenty_five_drones.json](https://cosysgit.uantwerpen.be/sensorsimulation/airsim/-/blob/master/ros/src/airsim_tutorial_pkgs/settings/twenty_five_drones.json) ```shell $ source PATH_TO/AirSim/ros/devel/setup.bash diff --git a/ros/cplusplus_ws/src/airsim_tutorial_pkgs/scripts/multi_drone_json_creator.py b/ros/cplusplus_ws/src/airsim_tutorial_pkgs/scripts/multi_drone_json_creator.py index 66ff98193..a81b80142 100644 --- a/ros/cplusplus_ws/src/airsim_tutorial_pkgs/scripts/multi_drone_json_creator.py +++ b/ros/cplusplus_ws/src/airsim_tutorial_pkgs/scripts/multi_drone_json_creator.py @@ -28,7 +28,7 @@ def __init__(self, sim_mode="Multirotor"): self.data = {} def add_minimal(self): - self.data["SeeDocsAt"] = "https://github.com/Microsoft/AirSim/blob/master/docs/settings.md" + self.data["SeeDocsAt"] = "https://cosysgit.uantwerpen.be/sensorsimulation/airsim/-/blob/master/docs/settings.md" self.data["SettingsVersion"] = 1.2 self.data["SimMode"] = self.sim_mode #"Multirotor" self.data["ClockSpeed"] = 1 diff --git a/ros/cplusplus_ws/src/airsim_tutorial_pkgs/settings/front_stereo_and_center_mono.json b/ros/cplusplus_ws/src/airsim_tutorial_pkgs/settings/front_stereo_and_center_mono.json index 1b65b9508..c71526a7e 100644 --- a/ros/cplusplus_ws/src/airsim_tutorial_pkgs/settings/front_stereo_and_center_mono.json +++ b/ros/cplusplus_ws/src/airsim_tutorial_pkgs/settings/front_stereo_and_center_mono.json @@ -1,5 +1,5 @@ { - "SeeDocsAt": "https://github.com/Microsoft/AirSim/blob/master/docs/settings.md", + "SeeDocsAt": "https://cosysgit.uantwerpen.be/sensorsimulation/airsim/-/blob/master/docs/settings.md", "SettingsVersion": 1.2, "SimMode": "Multirotor", "ViewMode": "SpringArmChase", diff --git a/ros/cplusplus_ws/src/airsim_tutorial_pkgs/settings/twenty_five_drones.json b/ros/cplusplus_ws/src/airsim_tutorial_pkgs/settings/twenty_five_drones.json index 998f74a0f..3a812d8ed 100644 --- a/ros/cplusplus_ws/src/airsim_tutorial_pkgs/settings/twenty_five_drones.json +++ b/ros/cplusplus_ws/src/airsim_tutorial_pkgs/settings/twenty_five_drones.json @@ -1,6 +1,6 @@ { "ClockSpeed": 1, - "SeeDocsAt": "https://github.com/Microsoft/AirSim/blob/master/docs/settings.md", + "SeeDocsAt": "https://cosysgit.uantwerpen.be/sensorsimulation/airsim/-/blob/master/docs/settings.md", "SettingsVersion": 1.2, "SimMode": "Multirotor", "Vehicles": { diff --git a/ros/cplusplus_ws/src/airsim_tutorial_pkgs/settings/two_drones_camera_lidar_imu.json b/ros/cplusplus_ws/src/airsim_tutorial_pkgs/settings/two_drones_camera_lidar_imu.json index 8c48ab125..88141a9a3 100644 --- a/ros/cplusplus_ws/src/airsim_tutorial_pkgs/settings/two_drones_camera_lidar_imu.json +++ b/ros/cplusplus_ws/src/airsim_tutorial_pkgs/settings/two_drones_camera_lidar_imu.json @@ -1,6 +1,6 @@ { "ClockSpeed": 1, - "SeeDocsAt": "https://github.com/Microsoft/AirSim/blob/master/docs/settings.md", + "SeeDocsAt": "https://cosysgit.uantwerpen.be/sensorsimulation/airsim/-/blob/master/docs/settings.md", "SettingsVersion": 1.2, "SimMode": "Multirotor", "Vehicles": { diff --git a/ros/python_ws/src/airsim/scripts/airsimpy/client.py b/ros/python_ws/src/airsim/scripts/airsimpy/client.py index f5a9eb2fe..b8e7a0689 100644 --- a/ros/python_ws/src/airsim/scripts/airsimpy/client.py +++ b/ros/python_ws/src/airsim/scripts/airsimpy/client.py @@ -260,7 +260,7 @@ def waitOnLastTask(timeout_sec = float('nan')): # legacy handling # TODO: remove below legacy wrappers in future major releases - upgrade_api_help = "\nPlease see https://github.com/Microsoft/AirSim/blob/master/docs/upgrade_apis.md for more info." + upgrade_api_help = "\nPlease see https://cosysgit.uantwerpen.be/sensorsimulation/airsim/-/blob/master/docs/upgrade_apis.md for more info." def simGetPose(self): logging.warning("simGetPose API is renamed to simGetVehiclePose. Please update your code." + self.upgrade_api_help) return self.simGetVehiclePose() diff --git a/setup.sh b/setup.sh index eeecd3c78..fa211e875 100755 --- a/setup.sh +++ b/setup.sh @@ -3,7 +3,7 @@ if [[ -d "llvm-source-39" ]]; then echo "Hello there! We just upgraded AirSim to Unreal Engine 4.22." echo "Here are few easy steps for upgrade so everything is new and shiny :)" - echo "https://github.com/Microsoft/AirSim/blob/master/docs/unreal_upgrade.md" + echo "https://cosysgit.uantwerpen.be/sensorsimulation/airsim/-/blob/master/docs/unreal_upgrade.md" exit 1 fi