We open-source KF-GINS1, an EKF-based GNSS/INS integrated navigation system. KF-GINS implements the classical integrated navigation solution of GNSS positioning results and IMU data. The KF-GINS follows the course content of "Inertial Navigation Principles and GNSS/INS Integrated Navigation" by Prof. Xiaoji Niu and Dr. Qijin Chen, as a supporting resource for the cource. The software is developed in C++ programming language, and CMake is used to manage the project.
The main features of KF-GINS are as follows:
- A GNSS/INS loosely-coupled integrated navigation algorithm based on the extended Kalman filter architecture (error state vector), including IMU error compensation, inertial navigation solution, Kalman filter, error feedback, etc.
- 21-dimensional error states are defined in the system, including position errors, velocity errors, attitude errors, IMU bias errors, and IMU scale factor errors
- The attitude errors adopt the Phi-angle model, and the velocity errors and position errors are defined in the navigation frame.
- The inertial navigation solution adopts the two-sample mechanization algorithm based on the linear assumption, which compensates for the second-order coning correction, the rotational motion, and the sculling motion.
Origanization: Integrated and Intelligent Navigation (i2Nav) Group, GNSS Research Center, Wuhan University.
Related Reference:
- 牛小骥, 陈起金, "惯性导航原理与GNSS/INS组合导航课程讲义", 武汉大学多源智能导航实验室, 2022
- 牛小骥, 陈起金, "惯性导航原理与GNSS/INS组合导航课程视频", 武汉大学多源智能导航实验室， 2022
- X. Niu, Q. Zhang, L. Gong, C. Liu, H. Zhang, C. Shi, J. Wang and M. Coleman (2014). "Development and evaluation of GNSS/INS data processing software for position and orientation systems." Survey Review 2014; 47(341), 87-98.
- 严恭敏, 翁浚, 捷联惯导算法与组合导航原理. 西北工业大学出版社, 2019.
- E.-H. Shin, "Estimation techniques for low-cost inertial navigation," Ph.D. dissertation, Dept. Geomatics Eng., Univ. of Calary, AB, Cabada, 2005
- Savage, P.G., "Strapdown analytics, Part I", Maple Plain, MN: Strapdown Associates, 2000.
- Titterton David, JohnL. Weston, and John Weston, "Strapdown inertial navigation technology", The Institution of Electrical Engineers, 2004.
- P. D. Groves, "Principles of GNSS, Inertial, and Multi-sensor Integrated Navigation Systems", 2nd ed., vol. 39. Artech House, 2013.
If you use this software for your academic research, please give acknowledgment as follows and cite our related document and papers
English version: “The authors would like to acknowledge the team of Prof. Xiaoji Niu of the Integrated and Intelligent Navigation (i2Nav) group from GNSS Research Center of Wuhan University for providing the open-source KF-GINS software that was used in the paper.”
中文模板：“本文作者感谢武汉大学卫星导航定位技术研究中心多源智能导航实验室(i2Nav)牛小骥教授团队开源的KF-GINS软件平台。”
Contacts:
- For any technique problem, you can send an email to Liqiang Wang (wlq@whu.edu.cn) or Dr. Hailiang Tang (thl@whu.edu.cn).
- For Chinese users, we also provide a QQ group (481173293) for discussion. You are requested to provide your organization and name to join the QQ group.
KF-GINS is managed by CMake and can be compiled on all of Linux, MacOS and Windows. We recommend you choose Linux environment first.
The configuration file is used as a parameter to run KF-GINS after successfully compiling it. To debug the program, it is also required to add the configuration file as a parameter.
KF-GINS requires another three libraries, which are Eigen3, abseil-cpp, and yaml-cpp. We have appended them as the thirdparty libraries in the ThirdParty directory.
We recommend you use g++ compiler of Ubuntu18.04 or Ubuntu20.04 to compile KF-GINS. You should install the build-essential libraries following the commonds:
sudo apt-get install cmake
sudo apt-get install build-essentialAfter preparing your own compilation environment, you can clone the repository locally and compile KF-GINS as follows:
# Clone the repository
git clone https://github.com/i2Nav-WHU/KF-GINS.git ~/
# Build KF-GINS
cd ~/KF-GINS
mkdir build && cd build
cmake ../ -DCMAKE_BUILD_TYPE=Release
make -j8
# Run demo dataset
cd ~/KF-GINS
./bin/KF-GINS ./dataset/kf-gins.yaml
# Wait until the program finishThe MSVC(Microsoft Visual C/C++) compiler is generally used in Windows. We recommend you to compile KF-GINS in the VSCode software.
You should first install the MSVC compiler and VScode software (including the necessary plug-ins, such as C/C++, C/C++ Extension Pack, CMake, and CMake Tools).
After preparing your own compilation environment, you can clone the repository locally and open the KF-GINS folder in VSCode:
- Set compiler: open the Command Palette (Ctrl+Shift+P) and type "CMake: Select a Kit", select the MSVC compilier
- Set compile parameter: type "CMake: Select Variant" in the Command Palette, select "Release"
- Configure CMake: type "CMake: Configure" in the Command Palette
- Compile Project: type "CMake: Build" in the Command Palette
Open a PowerShell or CMD terminal in the project directory and run the test dataset:
.\bin\KF-GINS.exe .\dataset\kf-gins.yaml
# The executable file may be generated in the '.\bin\Release' directory. Then the command is:
# .\bin\Release\KF-GINS.exe .\dataset\kf-gins.yamlxcode-select and cmake in MacOS. You should install these tools following the commonds:
xcode-select --install
brew install cmakeAfter preparing your own compilation environment, you can clone the repository locally and compile KF-GINS as follows:
# Clone the repository
git clone https://github.com/i2Nav-WHU/KF-GINS.git ~/
# Build KF-GINS
cd ~/KF-GINS
mkdir build && cd build
cmake ../ -DCMAKE_BUILD_TYPE=Release
make -j8
# Run demo dataset
cd ~/KF-GINS
./bin/KF-GINS ./dataset/kf-gins.yaml
# Wait until the program finishGDB debugging tool is required to debug KF-GINS under Linux. You should install it following the command.
sudo apt-get install gdbThe debug operation is as follows:
- Set compiler: open the Command Palette (Ctrl+Shift+P) and type "CMake: Select a Kit", select GCC for Linux, select "clang 15.0.0 arm64-apple-darwin23.5.0"(or above) for MacOS with M-series Chip or select the MSVC compilier for Windows
- Set compile parameter: type "CMake: Select Variant" in the Command Palette, select Debug
- Configure CMake: type "CMake: Configure" in the Command Palette, Compile Project: type "CMake: Build" in the Command Palette
- Set debug startup option: click the fourth button on the left side of VSCode to open the "Run and Debug" menu (or the shortcut key Ctrl+Shift+D), and select "Windows 启动", "Linux gdb 启动" or "Mac lldb 启动" at the top of this menu window.
- Start debugging, click the green triangle symbol at the top of the left window (or the shortcut key F5) to start debugging.
Frame defination:
- IMU frame: the origin is the IMU center, the three axes point forward-right-down
- Navigation reference frame: the origin coincides with the IMU frame, the three axes point north-east-down
Navigation state:
- position: the geodetic coordinates of the IMU position in the Earth frame (latitude-longitude-ellipsoid height)
- velocity: the IMU velocity to the Earth projected in the navigation reference frame (north speed-east speed-down speed)
- attitude: IMU attitude to navigation frame (quaternion, direction consine matrix, or euler angles. euler angles are defined as yaw-pitch-roll, ZYX rotation order)
IMU noise model:
- IMU measurement noises are modeled as the Gaussian white noise
- IMU bias errors are modeled as the firt-order Gauss-Markov process
- IMU scale factor errors are modeled as the firt-order Gauss-Markov process
For more details on the algorithm, please refer to 惯性导航原理与GNSS/INS组合导航课程讲义.
- The IMU text file format is defined as:
| Columns | Data description | Units |
|---|---|---|
| 1 | GNSS seconds of week | |
| 2~4 | X-Y-Z axes incremental angles | |
| 5~7 | X-Y-Z axes incremental velocity |
- The GNSS position text file format is defined as:
| Columns | Data description | Units |
|---|---|---|
| 1 | GNSS seconds of week | |
| 2 | latitude | |
| 3 | longitude | |
| 4 | ellipsoid altitude | |
| 5~7 | position STD (north-east-down) |
- The text file format of the navigation result and the ground-truth is defined as:
| Columns | Data description | Units |
|---|---|---|
| 1 | GNSS week | - |
| 2 | GNSS seconds of week | |
| 3 | latitude | |
| 4 | longitude | |
| 5 | ellipsoid altitude | |
| 6~8 | 3-D velocity (north-east-down) | |
| 9~11 | attitude angles (roll-pitch-yaw) |
- The IMU error text file format(all double data) is defined as:
| Columns | Data description | Units |
|---|---|---|
| 1 | GNSS seconds of week | |
| 2~4 | X-Y-Z axes gyroscope biases | |
| 5~7 | X-Y-Z axes accelerometer biases | |
| 8~10 | X-Y-Z axes gyroscope scale factors | |
| 11~13 | X-Y-Z axes accelerometer scale factors |
- The state STD text file format(all double data) is defined as:
| Columns | Data description | Units |
|---|---|---|
| 1 | GNSS seconds of week | |
| 2~4 | 3-D position STD (north-east-down) | |
| 5~7 | 3-D velocity STD (north-east-down) | |
| 8~10 | 3-D attitude STD (roll-pitch-yaw) | |
| 11~13 | X-Y-Z axes gyroscope bias STD | |
| 14~16 | X-Y-Z axes accelerometer bias STD | |
| 17~19 | X-Y-Z axes gyroscope scale factor STD | |
| 20~22 | X-Y-Z axes accelerometer scale factor STD |
KF-GINS only supports initial alignment given all initial states currently. The initial states need to be set in the configuration file (kf-gins.yaml) before executing the program.
We offer a demo dataset with the configuration file, which is located in the dataset directory.
Users can find our open-sourced datasets at awesome-gins-datasets.
The data formats used in KF-GINS are the same as the formats defined at awesome-gins-datasets. You can follow the formats to prepare your own datasets.
The source code is released under GPLv3 license.
We are still working on improving the code reliability. For any technical issues, please contact Liqiang Wang (wlq@whu.edu.cn) or Hailiang Tang (thl@whu.edu.cn), or open an issue at this repository. For commercial usage, please contact Prof. Xiaoji Niu (xjniu@whu.edu.cn).