Improving CI scripts - run docrs in the process (#240)

* Improving CI scripts - run docrs in the process
* remove debug trace
* remove unused variable
* add more ci scripts

---------

Signed-off-by: Guillaume W. Bres <[email protected]>

.github/workflows/rust.yml

@@ -69,6 +69,16 @@ jobs:
       with:
         command: build
         args: --all-features --release
+
+    - uses: actions-rs/toolchain@v1
+      name: Install nightly
+      with:
+        toolchain: nightly
+        override: true
+
+    - name: Documentation
+      run: |
+        ./tools/builddoc.sh
   
   windows-build:
     runs-on: windows-latest

.gitignore

@@ -1,5 +1,6 @@
 debug/
 target/
+logs/
 
 test_resources/
 

crx2rnx/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "crx2rnx"
-version = "2.3.3"
+version = "2.3.4"
 license = "MIT OR Apache-2.0"
 authors = ["Guillaume W. Bres <[email protected]>"]
 description = "RINEX data decompressor"
@@ -12,4 +12,4 @@ readme = "README.md"
 
 [dependencies]
 clap = { version = "4.4.13", features = ["derive", "color"] }
-rinex = { path = "../rinex", version = "=0.16.0", features = ["serde"] }
+rinex = { path = "../rinex", version = "=0.16.1", features = ["serde"] }

rinex-cli/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "rinex-cli"
-version = "0.11.0"
+version = "0.11.1"
 license = "MIT OR Apache-2.0"
 authors = ["Guillaume W. Bres <[email protected]>"]
 description = "Command line tool parse and analyze RINEX data"
@@ -32,8 +32,8 @@ horrorshow = "0.8"
 clap = { version = "4.4.13", features = ["derive", "color"] }
 hifitime = { version = "3.9.0", features = ["serde", "std"] }
 gnss-rs = { version = "2.1.3" , features = ["serde"] }
-rinex = { path = "../rinex", version = "=0.16.0", features = ["full"] }
-rinex-qc = { path = "../rinex-qc", version = "=0.1.13", features = ["serde"] } 
+rinex = { path = "../rinex", version = "=0.16.1", features = ["full"] }
+rinex-qc = { path = "../rinex-qc", version = "=0.1.14", features = ["serde"] } 
 sp3 = { path = "../sp3", version = "=1.0.8",  features = ["serde", "flate2"] }
 serde = { version = "1.0", default-features = false, features = ["derive"] }
 

rinex-qc/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "rinex-qc"
-version = "0.1.13"
+version = "0.1.14"
 license = "MIT OR Apache-2.0"
 authors = ["Guillaume W. Bres <[email protected]>"]
 description = "RINEX data analysis"
@@ -28,7 +28,7 @@ itertools = "0.12.0"
 statrs = "0.16"
 sp3 = { path = "../sp3", version = "=1.0.8", features = ["serde"] }
 rinex-qc-traits = { path = "../qc-traits", version = "=0.1.1" }
-rinex = { path = "../rinex", version = "=0.16.0", features = ["full"] }
+rinex = { path = "../rinex", version = "=0.16.1", features = ["full"] }
 gnss-rs = { version = "2.1.3", features = ["serde"] }
 
 [dev-dependencies]

rinex/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "rinex"
-version = "0.16.0"
+version = "0.16.1"
 license = "MIT OR Apache-2.0"
 authors = ["Guillaume W. Bres <[email protected]>"]
 description = "Package to parse and analyze RINEX data"

rinex/src/domes.rs

@@ -4,7 +4,7 @@ use thiserror::Error;
 use serde::{Deserialize, Serialize};
 
 #[cfg(docrs)]
-pub use bibliography::Bibliography;
+pub use crate::bibliography::Bibliography;
 
 /// DOMES parsing error
 #[derive(Debug, Error)]

rinex/src/lib.rs

@@ -2516,7 +2516,6 @@ impl Rinex {
          */
         let t0 = self.first_epoch().unwrap(); // will fail on invalid RINEX
         let t0 = Epoch::from_utc_days(t0.to_utc_days().round());
-        dbg!(t0);
         Box::new(
             self.header
                 .ionod_corrections
@@ -2645,7 +2644,7 @@ impl Rinex {
         carrier: Carrier,
     ) -> Option<f64> {
         // determine nearest in time
-        let (t_i, (model_sv, model)) = self
+        let (_, (model_sv, model)) = self
             .ionod_correction_models()
             .filter_map(|(t_i, (_, sv_i, msg_i))| {
                 // TODO

rnx2crx/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "rnx2crx"
-version = "1.2.3"
+version = "1.2.4"
 license = "MIT OR Apache-2.0"
 authors = ["Guillaume W. Bres <[email protected]>"]
 description = "RINEX data compressor"
@@ -14,4 +14,4 @@ readme = "README.md"
 [dependencies]
 thiserror = "1"
 clap = { version = "4.4.13", features = ["derive", "color"] }
-rinex = { path = "../rinex", version = "=0.16.0", features = ["serde"] }
+rinex = { path = "../rinex", version = "=0.16.1", features = ["serde"] }

tools/ci-ppp.sh

@@ -0,0 +1,27 @@
+#! /bin/bash
+# Small script to test PPP capabilities across toolbox updates
+
+# make sure we're in the correct setup
+cargo build --all-features -r
+
+LOGS="logs/ci/ppp"
+APP="./target/release/rinex-cli -q"
+
+PPP_CONTEXT="-f test_resources/CRNX/V3/ESBC00DNK_R_20201770000_01D_30S_MO.crx.gz \
+    -f test_resources/NAV/V3/ESBC00DNK_R_20201770000_01D_MN.rnx.gz \
+    -f test_resources/CLK/V3/GRG0MGXFIN_20201770000_01D_30S_CLK.CLK.gz \
+    -f test_resources/SP3/GRG0MGXFIN_20201770000_01D_15M_ORB.SP3.gz"
+
+mkdir -p $LOGS
+export RUST_LOG=trace
+
+# Default PPP | GPS
+$APP $PPP_CONTEXT -P GPS -p | tee $LOGS/gps_default.logs
+# Default PPP + CGGTTS | GPS
+$APP $PPP_CONTEXT -P GPS -p --cggtts | tee $LOGS/gps_default_cggtts.logs
+# Default PPP | GAL
+$APP $PPP_CONTEXT -P GAL -p | tee $LOGS/galileo_default.logs
+# Advanced SPP | GPS
+$APP $PPP_CONTEXT -P GPS -p -c rinex-cli/config/rtk/gpst_spp_basic.json | tee $LOGS/gps_spp_advanced.logs
+# # Advanced SPP | GAL
+$APP $PPP_CONTEXT -P GPS -p -c rinex-cli/config/rtk/gst_spp_basic.json | tee $LOGS/galileo_spp_advanced.logs

tools/testlib.sh

@@ -1,4 +1,5 @@
 #! /bin/sh
-VERBOSE=$1
-cargo test --features tests
-cargo test --all-features
+cargo fmt
+cargo test -- --nocapture
+cargo test --all-features -- --nocapture
+./tools/builddoc.sh

ublox-rnx/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "ublox-rnx"
-version = "0.1.6"
+version = "0.1.7"
 license = "MIT OR Apache-2.0"
 authors = ["Guillaume W. Bres <[email protected]>"]
 description = "Efficient RINEX production from a Ublox GNSS receiver"
@@ -22,4 +22,4 @@ serialport = "4.2.0"
 ublox = "0.4.4"
 clap = { version = "4.4.10", features = ["derive", "color"] }
 gnss-rs = { version = "2.1.3", features = ["serde"] }
-rinex = { path = "../rinex", version = "=0.16.0", features = ["serde", "nav", "obs", "clock"] }
+rinex = { path = "../rinex", version = "=0.16.1", features = ["serde", "nav", "obs", "clock"] }