V0.16 (#235)

* V0.16 release * fix cggtts generation * improving help menu * run clippy * ionod_correction: fix - calculations are limited to Kb models --------- Signed-off-by: Guillaume W. Bres <guillaume.bressaix@gmail.com>
georust · Apr 27, 2024 · 9cd94d8 · 9cd94d8
1 parent 0ec6df1
commit 9cd94d8
Show file tree

Hide file tree

Showing 21 changed files with 233 additions and 182 deletions.
diff --git a/Cargo.toml b/Cargo.toml
@@ -9,6 +9,7 @@ members = [
     "rinex-cli", 
     "rnx2crx", 
     "sp3",
+    "sinex",
     "ublox-rnx", 
 ]
 

diff --git a/crx2rnx/Cargo.toml b/crx2rnx/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "crx2rnx"
-version = "2.3.2"
+version = "2.3.3"
 license = "MIT OR Apache-2.0"
 authors = ["Guillaume W. Bres <guillaume.bressaix@gmail.com>"]
 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.15.7", features = ["serde"] }
+rinex = { path = "../rinex", version = "=0.16.0", features = ["serde"] }
diff --git a/rinex-cli/Cargo.toml b/rinex-cli/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "rinex-cli"
-version = "0.10.2"
+version = "0.11.0"
 license = "MIT OR Apache-2.0"
 authors = ["Guillaume W. Bres <guillaume.bressaix@gmail.com>"]
 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.15.7", features = ["full"] }
-rinex-qc = { path = "../rinex-qc", version = "=0.1.12", features = ["serde"] } 
+rinex = { path = "../rinex", version = "=0.16.0", features = ["full"] }
+rinex-qc = { path = "../rinex-qc", version = "=0.1.13", features = ["serde"] } 
 sp3 = { path = "../sp3", version = "=1.0.8",  features = ["serde", "flate2"] }
 serde = { version = "1.0", default-features = false, features = ["derive"] }
 
@@ -42,9 +42,9 @@ plotly =  "0.8.4"
 # plotly = { git = "https://github.com/gwbres/plotly", branch = "density-mapbox" }
 
 # solver
-# gnss-rtk = { version = "0.4.3", features = ["serde"] }
+gnss-rtk = { version = "0.4.4", features = ["serde"] }
 # gnss-rtk = { path = "../../rtk-rs/gnss-rtk", features = ["serde"] }
-gnss-rtk = { git = "https://github.com/rtk-rs/gnss-rtk", branch = "main", features = ["serde"] }
+# gnss-rtk = { git = "https://github.com/rtk-rs/gnss-rtk", branch = "main", features = ["serde"] }
 
 # cggtts
 cggtts = { version = "4.1.4", features = ["serde", "scheduler"] }

diff --git a/rinex-cli/src/cli/fops/filegen.rs b/rinex-cli/src/cli/fops/filegen.rs
@@ -8,8 +8,23 @@ pub fn subcommand() -> Command {
         .long_flag("filegen")
         .arg_required_else_help(false)
         .about(
-            "RINEX Data formatting. Use this option to preprocess, modify and dump results as RINEX. 
-You can use this for example, to generate a decimated RINEX file from an input Observations file.",
+            "Parse, preprocess and generate data while preserving input format. See --filegen --help."
+        )
+        .long_about("
+Use this mode to generate all file formats we support after preprocessing them.
+
+Example (1): generate decimated RINEX Observations
+rinex-cli \\
+    -f test_resources/CRNX/V3/ESBC00DNK_R_20201770000_01D_30S_MO.crx.gz \\
+    -P decim:5min \\
+    --filegen
+
+Example (2): redefine production agency while we do that
+rinex-cli \\
+    -f test_resources/CRNX/V3/ESBC00DNK_R_20201770000_01D_30S_MO.crx.gz \\
+    -P decim:5min \\
+    --filegen -a AGENCY
+"
         )
         .next_help_heading("Production Environment")
         .args(SHARED_GENERAL_ARGS.iter())

diff --git a/rinex-cli/src/cli/mod.rs b/rinex-cli/src/cli/mod.rs
@@ -126,7 +126,8 @@ impl Cli {
                         .value_name("FILE")
                         .action(ArgAction::Append)
                         .required_unless_present("directory")
-                        .help("Load a single file. Use this as many times as needed. 
+                        .help("Load a single file. See --help")
+                        .long_help("Use this as many times as needed. 
 Available operations and following behavior highly depends on input data. 
 Supported formats are:
 - Observation RINEX
@@ -136,34 +137,60 @@ Supported formats are:
 - SP3 (high precision orbits)
 - IONEX (Ionosphere Maps)
 - ANTEX (antenna calibration as RINEX)
-- DORIS (special Observation RINEX)"))
+- DORIS (special Observation RINEX)
+
+Example (1): Load a single file
+rinex-cli \\
+    -f test_resources/CRNX/V3/ESBC00DNK_R_20201770000_01D_30S_MO.crx.gz
+
+Example (2): define a PPP compliant context
+rinex-cli \\
+    -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
+"))
                     .arg(Arg::new("directory")
                         .short('d')
                         .long("dir")
                         .value_name("DIRECTORY")
                         .action(ArgAction::Append)
                         .required_unless_present("filepath")
-                        .help("Load directory recursively. Use this as many times as needed. Default recursive depth is set to 5,
+                        .help("Directory recursivel loader. See --help.")
+                        .long_help("Use this as many times as needed. Default recursive depth is set to 5,
 but you can extend that with --depth. Refer to -f for more information."))
                     .arg(Arg::new("depth")
                         .long("depth")
                         .action(ArgAction::Set)
                         .required(false)
                         .value_parser(value_parser!(u8))
-                        .help("Extend maximal recursive search depth of -d. The default is 5."))
+                        .help("Extend maximal recursive search depth of -d. The default is 5.")
+                        .long_help("The default recursive depth already supports hierarchies like:
+/YEAR1
+     /DOY0
+          /STATION1
+     /DOY1
+          /STATION2
+/YEAR2
+     /DOY0
+          /STATION1"))
                     .arg(Arg::new("quiet")
                         .short('q')
                         .long("quiet")
                         .action(ArgAction::SetTrue)
-                        .help("Disable all terminal output. Also disables auto HTML reports opener."))
+                        .help("Disable all terminal output. Also disables automatic HTML reports opening."))
                     .arg(Arg::new("workspace")
                         .short('w')
                         .long("workspace")
                         .value_name("FOLDER")
                         .value_parser(value_parser!(PathBuf))
-                        .help("Define custom workspace location. The env. variable RINEX_WORKSPACE, if present, is prefered.
-If none of those exist, we will generate local \"WORKSPACE\" folder."))
+                        .help("Define custom workspace location. See --help.")
+                        .long_help("The Workspace is where Output Products are to be generated.
+By default the $RINEX_WORKSPACE variable is prefered if it is defined.
+You can also use this flag to customize it. 
+If none are defined, we will then try to create a local directory named \"WORKSPACE\" like it is possible in this very repo."))
         .next_help_heading("Preprocessing")
+            .about("Preprocessing todo")
             .arg(Arg::new("gps-filter")
                 .short('G')
                 .action(ArgAction::SetTrue)