Skip to content

Commit 76ce1eb

Browse files
committed
update readme
Signed-off-by: Guillaume W. Bres <[email protected]>
1 parent 6893df7 commit 76ce1eb

File tree

1 file changed

+13
-5
lines changed

1 file changed

+13
-5
lines changed

README.md

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,23 +8,31 @@ Rust package to parse and generate CGGTTS data.
88
[![crates.io](https://docs.rs/cggtts/badge.svg)](https://docs.rs/cggtts/badge.svg)
99
[![crates.io](https://img.shields.io/crates/d/cggtts.svg)](https://crates.io/crates/cggtts)
1010

11-
CGGTTS is a file format to describe a local clock behavior against a single or the combination of clocks embedded in Satellite Vehicles (SV).
12-
Exchanging CGGTTS files enables so called "Common View" Time Transfer.
11+
CGGTTS is a file format designed to describe a local clock's behavior against GNSS constellations.
12+
Exchanging CGGTTS files then permits to compare two remote clocks to one another, this is called the called "Common View" Time Transfer
13+
technique.
1314

1415
CGGTTS is specified by the Bureau International des Poids & des Mesures (BIPM):
1516
[CGGTTS 2E specifications](https://www.bipm.org/documents/20126/52718503/G1-2015.pdf/f49995a3-970b-a6a5-9124-cc0568f85450)
1617

1718
This library only supports revision **2E**, and will _reject_ other revisions.
1819

20+
## Set of tools
21+
22+
- `cggtts` is the main library. Compile it with the _scheduler_ option to unlock
23+
full support of CGGTTS data production
24+
- `cggtts-cli` is an application to analyze one or compare to CGGTTS files to one another.
25+
Download its latest release from the [github portal](https://github.com/gwbres/cggtts/releases).
26+
1927
## Ecosystem
2028

2129
`CGGTTS` heavily relies on `Hifitime` for accurate _Epoch_ representation
2230
and _Timescales_ knowledge.
2331
Check out Christopher's amazing libraries [right here](https://github.com/nyx-space/hifitime).
2432

25-
The [RNX2CGGTTS application](https://github.com/georust/rinex) is the "goto" application when it comes
26-
to generate CGTTTS files. Use it to generate synchronous CGGTTS tracks from coherent RINEX contexts.
27-
You can then use "cggtts-cli" to compare two remote clocks.
33+
The [RNX2CGGTTS application](https://github.com/georust/rinex) is the _goto_ application when it comes
34+
to generate CGTTTS files. Use it to generate synchronous CGGTTS tracks from coherent RINEX contexts.
35+
Checkout the RINEX Wiki for examples of CGGTTS file exchanges.
2836

2937
## Crate achitecture
3038

0 commit comments

Comments
 (0)