Separate IONEX to dedicated lib (#376)

* Seperate IONEX to dedicated lib
* Update readme
* Update Docs
* Mark breaking change

---------

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

Author: gwbres

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "rinex"
-version = "0.20.2"
+version = "0.21.0"
 license = "MPL-2.0"
 authors = ["Guillaume W. Bres <[email protected]>"]
 description = "RINEX file parsing, analysis and production"
@@ -61,9 +61,6 @@ ut1 = [
 # METEO RINEX dedicated Iterators & methods.
 meteo = []
 
-# IONEX (special RINEX) dedicated Iterators & methods.
-ionex = []
-
 # CLOCK (Special RINEX) dedicated Iterators & methods.
 clock = []
 
@@ -101,7 +98,6 @@ full = [
     "clock",
     "doris",
     "flate2",
-    "ionex",
     "meteo",
     "nav",
     "obs",

README.md

@@ -20,23 +20,19 @@ To contribute to either of our project or join our community, you way
 ## Advantages :rocket: 
 
 - Fast
-- Open sources: read and access all the code!
+- Open sources: read and access all the code
 - All modern GNSS constellations, codes and signals
-  - Surveying with GPS, Galileo, BeiDou and QZSS
+  - GPS, Galileo, BeiDou and QZSS
 - Time scales: GPST, QZSST, BDT, GST, UTC, TAI
 - Efficient seamless compression and decompression
+  - modern rewrite of the Hatanaka compression algorithm
 - RINEX V4 full support, including
   - new Ionospheric coorections
   - new Time offset corrections
   - precise Earth Orientation updates
-- Navigation supported in the following constellations
-  - GPS
-  - Galileo
-  - BeiDou
-  - QZSS
-- Most RINEX formats supported (see following table)
-- High Precision Clock RINEX products (for PPP)
-- DORIS (special RINEX)
+- Supports Observation, Navigation, Meteo and Clock RINEX,
+other RINEX-like formats have their own parser:
+  - [IONEX](https://github.com/nav-solutions/ionex)
 - Many pre-processing algorithms including Filter Designer
 - Several file operations: merging, splitting, time binning (batch)
 
@@ -49,7 +45,7 @@ To contribute to either of our project or join our community, you way
 
 If you need to reference this work, please use the following model:
 
-`RTK-rs Team (2025), RINEX: analysis and processing (MPLv2), https://github.com/nav-solutions`
+`Nav-solutions (2025), RINEX: analysis and processing (MPLv2), https://github.com/nav-solutions`
 
 Formats & revisions
 ===================

src/epoch.rs

@@ -87,10 +87,6 @@ pub(crate) fn format(epoch: Epoch, t: Type, revision: u8) -> String {
                 format!("{:04} {:02} {:02} {:02} {:02} {:02}", y, m, d, hh, mm, ss)
             }
         },
-        Type::IonosphereMaps => format!(
-            "{:04}   {:>2}    {:>2}    {:>2}    {:>2}    {:>2}",
-            y, m, d, hh, mm, ss
-        ),
         _ => {
             if revision < 3 {
                 // old RINEX wants 2 digit YY field
@@ -217,52 +213,6 @@ pub(crate) fn parse_utc(s: &str) -> Result<Epoch, ParsingError> {
     parse_in_timescale(s, TimeScale::UTC)
 }
 
-pub(crate) fn parse_ionex_utc(s: &str) -> Result<Epoch, ParsingError> {
-    let (mut y, mut m, mut d, mut hh, mut mm, mut ss) = (0_i32, 0_u8, 0_u8, 0_u8, 0_u8, 0_u8);
-    for (index, field) in s.split_ascii_whitespace().enumerate() {
-        match index {
-            0 => {
-                y = field
-                    .trim()
-                    .parse::<i32>()
-                    .map_err(|_| ParsingError::EpochParsing)?;
-            },
-            1 => {
-                m = field
-                    .trim()
-                    .parse::<u8>()
-                    .map_err(|_| ParsingError::EpochParsing)?;
-            },
-            2 => {
-                d = field
-                    .trim()
-                    .parse::<u8>()
-                    .map_err(|_| ParsingError::EpochParsing)?;
-            },
-            3 => {
-                hh = field
-                    .trim()
-                    .parse::<u8>()
-                    .map_err(|_| ParsingError::EpochParsing)?;
-            },
-            4 => {
-                mm = field
-                    .trim()
-                    .parse::<u8>()
-                    .map_err(|_| ParsingError::EpochParsing)?;
-            },
-            5 => {
-                ss = field
-                    .trim()
-                    .parse::<u8>()
-                    .map_err(|_| ParsingError::EpochParsing)?;
-            },
-            _ => {},
-        }
-    }
-    Ok(Epoch::from_gregorian_utc(y, m, d, hh, mm, ss, 0))
-}
-
 pub(crate) fn epoch_decompose(epoch: Epoch) -> (i32, u8, u8, u8, u8, u8, u32) {
     epoch.to_gregorian(epoch.time_scale)
 }
@@ -573,19 +523,6 @@ mod test {
         assert_eq!(format(e, Type::MeteoData, 2), "22  1  4  0  0  0");
     }
 
-    #[test]
-    fn ionex_parsing() {
-        for (desc, expected) in [(
-            "  2022     1     2     0     0     0                        ",
-            Epoch::from_str("2022-01-02T00:00:00 UTC").unwrap(),
-        )] {
-            let epoch = parse_ionex_utc(desc);
-            assert!(epoch.is_ok(), "failed to parse IONEX/UTC epoch");
-            let epoch = epoch.unwrap();
-            assert_eq!(epoch, expected, "invalid IONEX/UTC epoch");
-        }
-    }
-
     #[test]
     fn epoch_decomposition() {
         for (epoch, y, m, d, hh, mm, ss, ns) in [

src/header/formatting.rs

@@ -214,7 +214,6 @@ impl Header {
             },
             Type::DORIS => {},
             Type::AntennaData => {},
-            Type::IonosphereMaps => {},
         }
 
         Ok(())
@@ -233,8 +232,6 @@ impl Header {
             meteo.format(w)
         } else if let Some(clock) = &self.clock {
             clock.format(w)
-        } else if let Some(ionex) = &self.ionex {
-            ionex.format(w)
         } else if let Some(antex) = &self.antex {
             antex.format(w)
         } else if let Some(doris) = &self.doris {

src/header/mod.rs

@@ -6,7 +6,6 @@ use crate::{
     doris::HeaderFields as DorisHeader,
     hardware::{Antenna, Receiver, SvAntenna},
     hatanaka::CRINEX,
-    ionex::HeaderFields as IonexHeader,
     leap::Leap,
     marker::GeodeticMarker,
     meteo::HeaderFields as MeteoHeader,
@@ -72,77 +71,104 @@ pub struct PcvCompensation {
 pub struct Header {
     /// RINEX [Version]
     pub version: Version,
+
     /// RINEX [Type]
     pub rinex_type: Type,
+
     /// GNSS [Constellation] describing this entire file.
     pub constellation: Option<Constellation>,
+
     /// Comments from this section
     pub comments: Vec<String>,
+
     /// Possible software name (publishing software)
     pub program: Option<String>,
+
     /// Possible software operator
     pub run_by: Option<String>,
+
     /// Possible date of publication
     pub date: Option<String>,
+
     /// Possible station / agency URL
     pub station_url: Option<String>,
+
     /// Name of observer / operator
     pub observer: Option<String>,
+
     /// Production Agency
     pub agency: Option<String>,
+
     /// Possible [GeodeticMarker]
     pub geodetic_marker: Option<GeodeticMarker>,
+
     /// Glonass FDMA channels
     pub glo_channels: HashMap<SV, i8>,
+
     /// Possible COSPAR number (launch information)
     pub cospar: Option<COSPAR>,
+
     /// Possible [Leap] seconds counter
     pub leap: Option<Leap>,
+
     /// Approximate coordinates expressed in ECEF m
     pub rx_position: Option<(f64, f64, f64)>,
+
     /// Optionnal wavelength correction factors
     pub wavelengths: Option<(u32, u32)>,
+
     /// Possible sampling interval
     pub sampling_interval: Option<Duration>,
+
     /// Possible file license
     pub license: Option<String>,
+
     /// Possible Digital Object Identifier
     pub doi: Option<String>,
+
     /// Possible [Receiver] information
     #[cfg_attr(feature = "serde", serde(default))]
     pub rcvr: Option<Receiver>,
+
     /// Possible information about Receiver [Antenna]
     #[cfg_attr(feature = "serde", serde(default))]
     pub rcvr_antenna: Option<Antenna>,
+
     /// Possible information about satellite vehicle antenna.
     /// This only exists in ANTEX format.
     #[cfg_attr(feature = "serde", serde(default))]
     pub sv_antenna: Option<SvAntenna>,
+
     /// Possible Ionospheric Delay correction model, described in
     /// header section of old RINEX files (<V4).
     pub ionod_corrections: HashMap<Constellation, IonosphereModel>,
+
     /// Possible DCBs compensation information
     pub dcb_compensations: Vec<DcbCompensation>,
+
     /// Possible PCVs compensation information
     pub pcv_compensations: Vec<PcvCompensation>,
+
     /// Observation RINEX specific fields
     #[cfg_attr(feature = "serde", serde(default))]
     pub obs: Option<ObservationHeader>,
+
     /// NAV RINEX specific fields
     #[cfg_attr(feature = "serde", serde(default))]
     pub nav: Option<NavigationHeader>,
+
     /// Meteo RINEX specific fields
     #[cfg_attr(feature = "serde", serde(default))]
     pub meteo: Option<MeteoHeader>,
+
     /// High Precision Clock RINEX specific fields
     #[cfg_attr(feature = "serde", serde(default))]
     pub clock: Option<ClockHeader>,
+
     /// ANTEX specific fields
     #[cfg_attr(feature = "serde", serde(default))]
     pub antex: Option<AntexHeader>,
-    /// IONEX specific fields
-    #[cfg_attr(feature = "serde", serde(default))]
-    pub ionex: Option<IonexHeader>,
+
     /// DORIS RINEX specific fields
     #[cfg_attr(feature = "serde", serde(default))]
     pub doris: Option<DorisHeader>,
@@ -175,7 +201,6 @@ impl Default for Header {
             wavelengths: None,
             cospar: None,
             doi: None,
-            ionex: None,
             meteo: None,
             nav: None,
             doris: None,
@@ -222,11 +247,6 @@ impl Header {
             .with_observation_fields(ObservationHeader::default().with_crinex(CRINEX::default()))
     }
 
-    /// Builds a basic [Header] for IONEX
-    pub fn basic_ionex() -> Self {
-        Self::default().with_ionex_fields(IonexHeader::default())
-    }
-
     /// Formats the package version (possibly shortenned, in case of lengthy release)
     /// to fit within a formatted COMMENT
     pub(crate) fn format_pkg_version(version: &str) -> String {
@@ -353,13 +373,6 @@ impl Header {
         s
     }
 
-    /// Copies and returns [Header] with specific [IonexHeader]
-    pub fn with_ionex_fields(&self, fields: IonexHeader) -> Self {
-        let mut s = self.clone();
-        s.ionex = Some(fields);
-        s
-    }
-
     /// Converts approximate coordinates to an [Orbit]
     /// at given point in spacetime and using [Frame] model
     #[cfg(feature = "nav")]