Skip to content

Commit 4d1ac06

Browse files
committed
Minor relocation and read me update
1 parent 2df7435 commit 4d1ac06

3 files changed

Lines changed: 5 additions & 5 deletions

File tree

core/README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,3 +38,7 @@ In addition to the core library there is a basic command line tool for evaluatin
3838

3939
1. **Open Loop**: This mode processes a set of inertial measurements (IMU data) and outputs the estimated position, velocity, and orientation over time in an open loop INS configuration; i.e. dead reckoning. This can be used to build an error state filter on top of or to develop a drift trajectory to compare your INS implementation to.
4040
2. **Closed Loop**: This mode processes a set of inertial measurements (IMU data) and outputs the estimated position, velocity, and orientation over time in a closed loop INS configuration; i.e. with aiding from an external source such as GNSS or a visual odometry system. This specific implementation uses a three-state position measurement (latitude, longitude, and altitude) to correct the INS state. This can be used to compare alternative or complimentary navigation aides to GPS-aided performance.
41+
42+
## Installation
43+
44+
There is both a library of navigation functionality and a command line tool for running dead-reckoning and cannonical closed-loop INS simulations. The library can be added to your Rust project as a dependency in your `Cargo.toml` file: `cargo add strapdown-rs`. The command line tool can be installed via `cargo install strapdown-rs`.

core/src/main.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ struct Args {
2121
output: PathBuf,
2222
}
2323

24-
fn write_results_to_csv(
24+
fn write_results_to_csv( // TODO: make this public and move to sim.rs
2525
results: &[NavigationResult],
2626
output: &PathBuf,
2727
) -> Result<(), Box<dyn Error>> {

core/src/sim.rs

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -195,7 +195,6 @@ pub struct NavigationResult {
195195
)]
196196
pub covariance: Option<Vec<f64>>,
197197
}
198-
199198
impl NavigationResult {
200199
/// Creates a new NavigationResult with default values.
201200
pub fn new(
@@ -346,7 +345,6 @@ impl NavigationResult {
346345
Ok(records)
347346
}
348347
}
349-
350348
/// Custom serializer for the covariance field to serialize it as a single string in CSV
351349
fn serialize_covariance<S>(cov: &Option<Vec<f64>>, serializer: S) -> Result<S::Ok, S::Error>
352350
where
@@ -365,7 +363,6 @@ where
365363
None => serializer.serialize_none(),
366364
}
367365
}
368-
369366
/// Custom deserializer for the covariance field to deserialize from a string in CSV
370367
fn deserialize_covariance<'de, D>(deserializer: D) -> Result<Option<Vec<f64>>, D::Error>
371368
where
@@ -385,7 +382,6 @@ where
385382
_ => Ok(None),
386383
}
387384
}
388-
389385
/// Run dead reckoning or "open-loop" simulation using test data.
390386
///
391387
/// This function processes a sequence of sensor records through a StrapdownState, using

0 commit comments

Comments
 (0)