Develop (#9)

* Documentation & tool update

---------

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

Author: gwbres

.gitignore

@@ -1,9 +1,11 @@
 # Generated by Cargo
 # will have compiled files and executables
 debug/
-data/
 target/
 
+data/
+WORKSPACE/
+
 # Remove Cargo.lock from gitignore if creating an executable, leave it for libraries
 # More information here https://doc.rust-lang.org/cargo/guide/cargo-toml-vs-cargo-lock.html
 Cargo.lock

Cargo.toml

@@ -27,7 +27,9 @@ lazy_static = "1.4"
 thiserror = "2"
 itertools = "0.14"
 map_3d = "0.1.5"
+
 maud = "0.26"
+plotly = "0.9"
 
 clap = { version = "4.4.13", features = ["derive", "color"] }
 serde = { version = "1.0", default-features = false, features = ["derive"] }
@@ -36,17 +38,17 @@ kml = { version = "0.8.6", optional = true }
 gpx = { version = "0.10", optional = true }
 csv = { version = "1.3.0", optional = true }
 
-plotly = "0.9"
-
 anise = { version = "0.5.3", features = ["embed_ephem"] }
 hifitime = { version = "4.0", features = ["serde", "std"] }
 
-gnss-rs = { version = "2.3.2", features = ["serde"] }
-gnss-rtk = { version = "0.7.5", features = ["serde"] }
-cggtts = { version = "4.2.0", features = ["serde", "scheduler"], optional = true }
+gnss-rs = { version = "2.3.5", features = ["serde"] }
 gnss-qc = { git = "https://github.com/rtk-rs/gnss-qc", branch = "main", features = ["sp3"] } 
 
-rinex = { git = "https://github.com/rtk-rs/rinex", branch = "main", features = ["obs", "nav", "ionex", "antex", "clock", "flate2", "processing", "serde"] }
-
 sp3 = { git = "https://github.com/rtk-rs/sp3", branch = "main", features = ["processing", "anise", "flate2", "serde"] }
 
+rinex = { git = "https://github.com/rtk-rs/rinex", branch = "main",  features = ["obs", "nav", "ionex", "antex", "clock", "flate2", "processing", "serde"] }
+
+gnss-rtk = { git = "https://github.com/rtk-rs/gnss-rtk", branch = "nav_x4", features = ["serde"] }
+# gnss-rtk = { path = "../gnss-rtk", features = ["serde"] }
+
+cggtts = { version = "4.2.0", features = ["serde", "scheduler"], optional = true }

README.md

@@ -29,10 +29,17 @@ Download the version you are interested in:
 git clone https://github.com/rtk-rs/rinex-cli
 ```
 
-And build it using cargo:
+This will build and install the stripped binary to `${HOME}/.cargo/bin`, which
+is usally defined in the ${PATH}. Because our examples span all applications, you should
+activate `--all-features`:
 
 ```bash
-cargo build --all-features -r
+cargo install --all-features --path .
+
+rinex-cli --version
+
+which rinex-cli
+${HOME}/.cargo/bin/rinex-cli
 ```
 
 ## File formats & revisions
@@ -64,32 +71,44 @@ Summary:
 
 ## Documentation
 
-If you intend to run our examples and tutorials on your side,
-you are expected to execute the `tools/download-data.sh` script first,
-which will retrieve the GeoRust/RINEX verification and test data, that we use
-for demonstration purposes. On linux, you can:
+If you intend to run our examples and tutorials,
+you are expected to first source our `tools/download-data.sh` script.  
+It will download our test data (a few RINEX files) and define the example environment:
 
 ```bash
-./tools/download-data.sh
+source tools/download-data.sh
+echo $DATA_DIR
 ```
 
-Once you have installed the tool, read
+Once you have installed the tool, read the first few steps:
+
+- [File loading interface](./documentation/FileLoading.md): learn how to load data into the toolbox
+- [The Preprocessor documentation](./documentation/Preprocessor.md) will teach you
+how design a filter and deploy up to complex processing pipelines
+- [The Input / Output page](./documentation/InputOutput.md) summarizes the output you can
+generate, based on your input products
+
+Then, continue your learning journey with:
+
+- [The Merge operation](./documentation/Merge.md): to merge RINEX files together,
+which is particularly useful in Data production context & files management
+
+- [The Split operation](./documentation/Split.md): demonstrates how to
+split one RINEX file into two
+
+- [Time Binning operation](./documentation/Tbin.md): allows creating a batch of RINEX
+from a single one (basically, dividing into sub-parts)
+
+- [The differentiation operation](./documentation/Diff.md): to create a special RINEX
+by substracting one from the other
+
+Dive into the world of precise navigation:
 
-- [The file loading documentation](./documentation/FileLoading.md) that will teach you
-how to load data into the toolbox
-- [The Preprocessor documentation](./documentation/Preprocessor.md) that will teach you
-how design a filter
-- [The Merge operation documentation](./documentation/Merge.md)
-- [The Split operation documentation](./documentation/Split.md)
-- [The Time Binning operation documentation](./documentation/Tbin.md)
-- [The Differentiation operation documentation](./documentation/Diff.md)
-- [The PPP opmode documentation](./documentation/PPP.md)
-- [The PPP with special CGGTTS option documentation](./documentation/CGGTTS.md)
+- [Introduction to the PPP (Post Processed Positioning) opmode](./documentation/PPP.md)
 
-## Examples
+- [Focus on the PPP +cggtts special option](./documentation/CGGTTS.md)
 
-We provide a set of [(command line) examples](./examples) written in Shell,
-that cover most applications.
+- [Many examples](./examples/README.md) are provided, spanning many applications
 
 Special Thanks
 ==============

data/.gitkeep

@@ -14,7 +14,7 @@ rinex-cli \
     diff data/ESBC00DNK_R_20201770000_01D_30S_MO.crx.gz
 ```
 
-Example (2): merging two CRINEX files together.
+Example (2): differentiate two CRINEX together
 
 ```bash
 rinex-cli \

documentation/Diff.md

@@ -37,6 +37,12 @@ rinex-cli -q -d data/
 
 ## File naming conventions
 
-The toolbox can operate on files that do not follow standard naming conventions.  
+The toolbox accepts files that do not follow standard naming conventions.
+
 Note that working with files that do not following standard naming conventions will limit our 
 smart file production capabilities. See [File Operations](./FileOperations) for more information.
+
+## Tutorials
+
+The output product you can generate, [now depends on the operation you will select
+and the input you just loaded](./InputOutput.md)

documentation/FileLoading.md

@@ -0,0 +1,10 @@
+File Production
+===============
+
+
+`rinex-cli` allows many operations to synthesize and rework RINEX data.  
+This is particularly useful when managing a batch of RINEX, or in the context
+of file production and publication.
+
+Because RINEX wraps many information, `rinex-cli` had to offer some means to
+customize and define

documentation/FileProduction.md

@@ -0,0 +1,62 @@
+Input / Output
+==============
+
+This table summarizes the output product you can generate,
+based on the selected opmode and the input product.
+
+`opmode` is the operation you requested. This toolbox
+supports one operation per run (to simplify internal logic),
+it will then adapt to the provided context.
+
+Quality Control (QC) is the default mode, and synthesizes a report.
+
+
+| Input                | Opmode              | Second argument   | Application                            | Output product(s)  |
+|----------------------|---------------------|-------------------|----------------------------------------|--------------------|
+| RINEX                | None                | None              | RINEX QC                               | report.html        |
+| SP3                  | None                | None              | SP3 QC                                 | report.html        |
+| RINEX + SP3          | None                | None              | Post processed, High precision geodesy | report.html        |
+
+`merge` I/O: 
+
+| Input                | Opmode              | Second argument                        | Application        | Output product(s)  |
+|----------------------|---------------------|----------------------------------------|--------------------|--------------------|
+| RINEX                | merge               | RINEX File                             | File management    | Merged RINEX       |
+| RINEX                | merge               | RINEX File `+rnx2crx`                  | File management    | Merged CRINEX      |
+| CRINEX               | merge               | RINEX File                             | File management    | Merged CRINEX      |
+| CRINEX               | merge               | RINEX File `+crx2rnx`                  | File management    | Merged RINEX       |
+
+`filegen` I/O:
+
+| Input                | Opmode              | Second argument                        | Application        | Output product(s)   |
+|----------------------|---------------------|----------------------------------------|--------------------|---------------------|
+| RINEX                | filegen             | None                                   | File management    | RINEX               |
+| RINEX                | filegen             | `+rnx2crx`                             | File management    | CRINEX              |
+| CRINEX               | filegen             | `+crx2rnx`                             | File management    | RINEX               |
+| RINEX /CRINEX        | filegen             | `+csv`                                 | File management    | Observations to CSV |
+| NAV RINEX            | filegen             | `+csv`                                 | File management    | Ephemeris to CSV    |
+
+`tbin` I/O:
+
+| Input                | Opmode              | Second argument                        | Application        | Output product(s)   |
+|----------------------|---------------------|----------------------------------------|--------------------|---------------------|
+| RINEX                | tbin                | Duration                               | File management    | RINEX Batch         |
+| RINEX                | tbin                | Duration  `+rnx2crx`                   | File management    | CRINEX Batch        |
+| CRINEX               | tbin                | Duration  `+crx2rnx`                   | File management    | RINEX Batch         |
+
+`diff` I/O:
+
+| Input                | Opmode              | Second argument                        | Application        | Output product(s)   |
+|----------------------|---------------------|----------------------------------------|--------------------|---------------------|
+| RINEX                | diff                | Reference RINEX File                   | File management    | Special RINEX(A-B)  |
+| CRINEX               | diff                | Reference RINEX File                   | File management    | Special CRINEX(A-B) |
+| CRINEX               | diff                | Reference RINEX File `+crx2rnx`        | File management    | Special RINEX(A-B)  |
+| RINEX                | diff                | Reference RINEX File `+rnx2crx`        | File management    | Special CRINEX(A-B) |
+
+All `File Mangement` application [accept many options](./FileProduction.md) that will let you customize your production context.
+
+
+## Tutorials
+
+Continue with reading the documentation of the [opmode(s) you are interested in](../README.md),
+follow our [examples](../examples/README.md) that span many applications.

documentation/InputOutput.md

@@ -0,0 +1,23 @@
+Post Processed Positioning
+==========================
+
+`rinex-cli` offers RINEX and SP3 exploitation
+for high precision post processed navigation.
+
+This mode is summoned with the `ppp` option, it accepts
+a custom configuration script and deploys after a possible preprocessing pipeline.
+
+Examples
+========
+
+We host many [Navigation examples](../PPP) spanning all use cases.
+We recommend reading this page prior getting started.
+
+RINEX-Cli behavior
+==================
+
+The tool's behavior is dictated by the input products.  
+If you only provide RINEX products, you place yourself in the real-time/BRDC scenario. 
+The tool will consume all observations remaining after the preprocessing pipeline. 
+If you stacked many RINEX (for example, 2x24h=48h surveying), will we consume all of them in chronological order.
+But you have to be aware of data gaps.

documentation/PPP.md

@@ -0,0 +1,10 @@
+Configuration scripts
+=====================
+
+Advanced opmodes like `ppp` or `cggtts` may accept a configuration script
+that allows advanced tuning.
+
+The Complete [Configuration documentation can be found here](https://github.com/rtk-rs).
+
+- Configurations that are designed for the [SPP Navigation Technique/Strategy](./SPP) 
+- Configurations that are designed for the [CPP (Dual Pseudo Range) Navigation Technique/Strategy](./CPP)