Update repository naming convention

unmannedlab · May 19, 2024 · 73fcc33 · 73fcc33
1 parent bd50490
commit 73fcc33
Show file tree

Hide file tree

Showing 10 changed files with 20 additions and 20 deletions.
diff --git a/.doxyfile b/.doxyfile
@@ -32,7 +32,7 @@ DOXYFILE_ENCODING      = UTF-8
 # title of most generated pages and in a few other places.
 # The default value is: My Project.
 
-PROJECT_NAME           = "EKF-CAL"
+PROJECT_NAME           = "ekf_cal"
 
 # The PROJECT_NUMBER tag can be used to enter a project or revision number. This
 # could be handy for archiving the generated documentation or if some version

diff --git a/.vscode/launch.json b/.vscode/launch.json
@@ -2,7 +2,7 @@
     "version": "2.0.0",
     "configurations": [
         {
-            "name": "EKF-CAL",
+            "name": "ekf_cal",
             "type": "cppdbg",
             "request": "launch",
             "program": "${workspaceFolder}/../../install/ekf_cal/lib/ekf_cal/ekf_cal_node",

diff --git a/CITATION.cff b/CITATION.cff
@@ -4,8 +4,8 @@ authors:
 - family-names: "Hartzer"
   given-names: "Jacob"
   orcid: "https://orcid.org/0000-0002-3051-2213"
-title: "EKF-CAL"
+title: "ekf_cal"
 version: 0.4.0
 # doi:
 # date-released:
-url: "https://github.com/unmannedlab/ekf-cal"
+url: "https://github.com/unmannedlab/ekf_cal"
diff --git a/README.md b/README.md
@@ -1,19 +1,19 @@
-# EKF-CAL
-[![Documentation](https://github.com/unmannedlab/ekf-cal/actions/workflows/documentation.yaml/badge.svg)](https://github.com/unmannedlab/ekf-cal/actions/workflows/documentation.yaml)
-[![Plant Tree](https://img.shields.io/badge/dynamic/json?color=brightgreen&label=Plant%20Tree&query=%24.total&url=https%3A%2F%2Fpublic.offset.earth%2Fusers%2Ftreeware%2Ftrees)](https://plant.treeware.earth/unmannedlab/ekf-cal)
+# ekf_cal
+[![Documentation](https://github.com/unmannedlab/ekf_cal/actions/workflows/documentation.yaml/badge.svg)](https://github.com/unmannedlab/ekf_cal/actions/workflows/documentation.yaml)
+[![Plant Tree](https://img.shields.io/badge/dynamic/json?color=brightgreen&label=Plant%20Tree&query=%24.total&url=https%3A%2F%2Fpublic.offset.earth%2Fusers%2Ftreeware%2Ftrees)](https://plant.treeware.earth/unmannedlab/ekf_cal)
 
-Extended Kalman Filter Calibration and Localization: EKF-CAL is a package focused on the simulation
+Extended Kalman Filter Calibration and Localization: ekf_cal is a package focused on the simulation
 and development of a multi-sensor online calibration kalman filter. It combines the architecture of
 a Multi-State Constraint Kalman Filter (MSCKF) with a multi-IMU calibration filter to provide
 estimates of intrinsic and extrinsic sensor calibration parameters.
 
 For full documentation, please see below:
-- [Github Repository](https://github.com/unmannedlab/ekf-cal/)
-- [Documentation](https://unmannedlab.org/ekf-cal/)
-- [Getting Started](https://unmannedlab.org/ekf-cal/tutorial.html)
+- [Github Repository](https://github.com/unmannedlab/ekf_cal/)
+- [Documentation](https://unmannedlab.org/ekf_cal/)
+- [Getting Started](https://unmannedlab.org/ekf_cal/tutorial.html)
 
 ## License
-This package is [Treeware](https://treeware.earth). If you use it in production, then we ask that you [**buy the world a tree**](https://plant.treeware.earth/unmannedlab/ekf-cal) to thank us for our work. By contributing to the Treeware forest you’ll be creating employment for local families and restoring wildlife habitats.
+This package is [Treeware](https://treeware.earth). If you use it in production, then we ask that you [**buy the world a tree**](https://plant.treeware.earth/unmannedlab/ekf_cal) to thank us for our work. By contributing to the Treeware forest you’ll be creating employment for local families and restoring wildlife habitats.
 
 ## References
 

diff --git a/docs/header.html b/docs/header.html
@@ -41,7 +41,7 @@
 <body>
 
     <!-- https://tholman.com/github-corners/ -->
-    <a href="https://github.com/unmannedlab/ekf-cal" class="github-corner" title="View source on GitHub" target="_blank">
+    <a href="https://github.com/unmannedlab/ekf_cal" class="github-corner" title="View source on GitHub" target="_blank">
         <svg viewBox="0 0 250 250" width="40" height="40"
             style="position: absolute; top: 0; border: 0; right: 0; z-index: 99;" aria-hidden="true">
             <path d="M0,0 L115,115 L130,115 L142,142 L250,250 L250,0 Z"></path>

diff --git a/docs/paper/paper.md b/docs/paper/paper.md
@@ -37,13 +37,13 @@ Existing Work:
 - [@Rehder]
 
 # Capabilities
-`EKF-CAL` supports any number or combination of the sensors listed in the following sections. Additionally, errors in the calibrations are modelled across Monte Carlo simulations.
+`ekf_cal` supports any number or combination of the sensors listed in the following sections. Additionally, errors in the calibrations are modelled across Monte Carlo simulations.
 
 ## IMU
-`EKF-CAL` supports the use of multiple IMU for updating the state estimate of acceleration and angular rates. A single IMU can be selected to provide state predictions, or all IMU can be used to provide state updates within the Extended Kalman Filter framework.
+`ekf_cal` supports the use of multiple IMU for updating the state estimate of acceleration and angular rates. A single IMU can be selected to provide state predictions, or all IMU can be used to provide state updates within the Extended Kalman Filter framework.
 
 ## Cameras
-`EKF-CAL` supports the use of multiple camera that can simultaneously use MSCKF-based feature tracking and fiducial marker tracking for state updates.
+`ekf_cal` supports the use of multiple camera that can simultaneously use MSCKF-based feature tracking and fiducial marker tracking for state updates.
 
 ## GPS
 Lorem ipsum.

diff --git a/docs/tutorial.md b/docs/tutorial.md
@@ -3,7 +3,7 @@ Getting Started {#tutorial}
 
 
 # Dependencies
-The EKF-CAL package has the following hard dependencies that are required for all compilations:
+The ekf_cal package has the following hard dependencies that are required for all compilations:
 - [OpenCV](https://opencv.org/)
 - [Eigen 3](https://eigen.tuxfamily.org/index.php?title=Main_Page)
 

diff --git a/eval/input_parser.py b/eval/input_parser.py
@@ -15,7 +15,7 @@
 # You should have received a copy of the GNU General Public License
 # along with this program.  If not, see <https://www.gnu.org/licenses/>.
 
-"""Define a common input parser for EKF-CAL tools."""
+"""Define a common input parser for ekf_cal tools."""
 
 import argparse
 

diff --git a/launch/example.launch.py b/launch/example.launch.py
@@ -23,7 +23,7 @@
 
 
 def generate_launch_description():
-    """Generate launch description for EKF-CAL example config."""
+    """Generate launch description for ekf_cal example config."""
     this_dir = get_package_share_directory('ekf_cal')
 
     start_ekf_cal_node_cmd = Node(

diff --git a/src/application/sim/simulation.cpp b/src/application/sim/simulation.cpp
@@ -69,7 +69,7 @@ int main(int argc, char * argv[])
   ;
 
   cv::CommandLineParser parser(argc, argv, keys);
-  parser.about("EKF-CAL Simulation: " + std::string(EKF_CAL_VERSION));
+  parser.about("ekf_cal Simulation: " + std::string(EKF_CAL_VERSION));
   if (parser.has("help") || (!parser.has("@config") || !parser.has("@out_dir"))) {
     parser.printMessage();
     return 0;