Merge pull request #368 from nyx-space/feat/serde

ChristopherRabotin · web-flow · commit 1af2fe625360 · 2024-12-29T14:50:16.000-07:00
Various cleaning up -&gt; version 0.5.2
diff --git a/Cargo.toml b/Cargo.toml
@@ -3,7 +3,7 @@ resolver = "2"
 members = ["anise", "anise-cli", "anise-gui", "anise-py"]
 
 [workspace.package]
-version = "0.5.1"
+version = "0.5.2"
 edition = "2021"
 authors = ["Christopher Rabotin <christopher.rabotin@gmail.com>"]
 description = "ANISE provides a toolkit and files for Attitude, Navigation, Instrument, Spacecraft, and Ephemeris data. It's a modern replacement of NAIF SPICE file."
@@ -45,7 +45,7 @@ pyo3-log = "0.12"
 numpy = "0.23"
 ndarray = ">= 0.15, < 0.17"
 
-anise = { version = "0.5.1", path = "anise", default-features = false }
+anise = { version = "0.5.2", path = "anise", default-features = false }
 
 [profile.bench]
 debug = true
diff --git a/anise-gui/Cargo.toml b/anise-gui/Cargo.toml
@@ -15,11 +15,11 @@ hifitime = { workspace = true }
 log = { workspace = true }
 bytes = { workspace = true }
 pretty_env_logger = { workspace = true }
-eframe = { version = "0.29" }
-egui = { version = "0.29" }
-egui_extras = { version = "0.29", features = ["datepicker", "http", "image"] }
+eframe = { version = "0.30" }
+egui = { version = "0.30" }
+egui_extras = { version = "0.30", features = ["datepicker", "http", "image"] }
 rfd = { version = "0.15.0" }
-egui_logger = "0.6.1"
+egui_logger = "0.6.2"
 
 [target.'cfg(target_arch = "wasm32")'.dependencies]
 wasm-bindgen-futures = "0.4"
diff --git a/anise/src/almanac/metaload/metaalmanac.rs b/anise/src/almanac/metaload/metaalmanac.rs
@@ -267,7 +267,7 @@ impl Default for MetaAlmanac {
                         .join("v0.5/moon_fk_de440.epa")
                         .unwrap()
                         .to_string(),
-                    crc32: Some(0x6f0ad74c),
+                    crc32: Some(0x21633903),
                 },
                 MetaFile {
                     uri: nyx_cloud_stor
diff --git a/anise/src/almanac/metaload/metafile.rs b/anise/src/almanac/metaload/metafile.rs
@@ -147,7 +147,7 @@ impl MetaFile {
                                                         self.uri = dest_path_s;
                                                         return Ok(());
                                                     } else {
-                                                        info!("Discarding cached {dest_path_s} - CRC32 differ (got {computed_crc32:x}, expected {crc32:x})");
+                                                        info!("Discarding cached {dest_path_s} - CRC32 differ (got 0x{computed_crc32:x}, expected 0x{crc32:x})");
                                                     }
                                                 }
                                             }
@@ -206,7 +206,7 @@ impl MetaFile {
                                                             file.write_all(&bytes).unwrap();
 
                                                             info!(
-                                                                 "Saved {url} to {} (CRC32 = {crc32:x})",
+                                                                 "Saved {url} to {} (CRC32 = 0x{crc32:x})",
                                                                  dest_path.to_str().unwrap()
                                                              );
 
diff --git a/anise/src/almanac/metaload/mod.rs b/anise/src/almanac/metaload/mod.rs
@@ -144,7 +144,7 @@ mod meta_test {
   , { crc32 = Some 0x8213b6e9
     , uri = "http://public-data.nyxspace.com/anise/v0.5/pck11.pca"
     }
-  , { crc32 = Some 0x6f0ad74c
+  , { crc32 = Some 0x21633903
     , uri = "http://public-data.nyxspace.com/anise/v0.5/moon_fk_de440.epa"
     }
   , { crc32 = Some 0xcde5ca7d
diff --git a/anise/src/astro/orbit.rs b/anise/src/astro/orbit.rs
@@ -54,12 +54,12 @@ impl Orbit {
     /// One should expect these errors to be on the order of 1e-12.
     #[allow(clippy::too_many_arguments)]
     pub fn try_keplerian(
-        sma: f64,
+        sma_km: f64,
         ecc: f64,
-        inc: f64,
-        raan: f64,
-        aop: f64,
-        ta: f64,
+        inc_deg: f64,
+        raan_deg: f64,
+        aop_deg: f64,
+        ta_deg: f64,
         epoch: Epoch,
         frame: Frame,
     ) -> PhysicsResult<Self> {
@@ -74,14 +74,14 @@ impl Orbit {
         } else {
             ecc
         };
-        let sma = if ecc > 1.0 && sma > 0.0 {
+        let sma = if ecc > 1.0 && sma_km > 0.0 {
             warn!("eccentricity > 1 (hyperbolic) BUT SMA > 0 (elliptical): sign of SMA changed");
-            sma * -1.0
-        } else if ecc < 1.0 && sma < 0.0 {
+            sma_km * -1.0
+        } else if ecc < 1.0 && sma_km < 0.0 {
             warn!("eccentricity < 1 (elliptical) BUT SMA < 0 (hyperbolic): sign of SMA changed");
-            sma * -1.0
+            sma_km * -1.0
         } else {
-            sma
+            sma_km
         };
         if (sma * (1.0 - ecc)).abs() < 1e-3 {
             // GMAT errors below one meter. Let's warn for below that, but not panic, might be useful for landing scenarios?
@@ -92,14 +92,14 @@ impl Orbit {
             ParabolicEccentricitySnafu { limit: ECC_EPSILON }
         );
         if ecc > 1.0 {
-            let ta_deg = between_0_360(ta);
+            let ta_deg = between_0_360(ta_deg);
             ensure!(
                 ta_deg <= (PI - (1.0 / ecc).acos()).to_degrees(),
                 HyperbolicTrueAnomalySnafu { ta_deg }
             );
         }
         ensure!(
-            (1.0 + ecc * ta.to_radians().cos()).is_finite(),
+            (1.0 + ecc * ta_deg.to_radians().cos()).is_finite(),
             InfiniteValueSnafu {
                 action: "computing radius of orbit"
             }
@@ -109,28 +109,28 @@ impl Orbit {
         // The conversion algorithm itself comes from GMAT's StateConversionUtil::ComputeKeplToCart
         // NOTE: GMAT supports mean anomaly instead of true anomaly, but only for backward compatibility reasons
         // so it isn't supported here.
-        let inc = inc.to_radians();
-        let raan = raan.to_radians();
-        let aop = aop.to_radians();
-        let ta = ta.to_radians();
-        let p = sma * (1.0 - ecc.powi(2));
+        let inc_rad = inc_deg.to_radians();
+        let raan_rad = raan_deg.to_radians();
+        let aop_rad = aop_deg.to_radians();
+        let ta_rad = ta_deg.to_radians();
+        let p_km = sma * (1.0 - ecc.powi(2));
 
-        ensure!(p.abs() >= f64::EPSILON, ParabolicSemiParamSnafu { p });
+        ensure!(p_km.abs() >= f64::EPSILON, ParabolicSemiParamSnafu { p_km });
 
         // NOTE: At this point GMAT computes 1+ecc**2 and checks whether it's very small.
         // It then reports that the radius may be too large. We've effectively already done
         // this check above (and panicked if needed), so it isn't repeated here.
-        let radius = p / (1.0 + ecc * ta.cos());
-        let (sin_aop_ta, cos_aop_ta) = (aop + ta).sin_cos();
-        let (sin_inc, cos_inc) = inc.sin_cos();
-        let (sin_raan, cos_raan) = raan.sin_cos();
-        let (sin_aop, cos_aop) = aop.sin_cos();
+        let radius = p_km / (1.0 + ecc * ta_rad.cos());
+        let (sin_aop_ta, cos_aop_ta) = (aop_rad + ta_rad).sin_cos();
+        let (sin_inc, cos_inc) = inc_rad.sin_cos();
+        let (sin_raan, cos_raan) = raan_rad.sin_cos();
+        let (sin_aop, cos_aop) = aop_rad.sin_cos();
         let x = radius * (cos_aop_ta * cos_raan - cos_inc * sin_aop_ta * sin_raan);
         let y = radius * (cos_aop_ta * sin_raan + cos_inc * sin_aop_ta * cos_raan);
         let z = radius * sin_aop_ta * sin_inc;
-        let sqrt_gm_p = (mu_km3_s2 / p).sqrt();
-        let cos_ta_ecc = ta.cos() + ecc;
-        let sin_ta = ta.sin();
+        let sqrt_gm_p = (mu_km3_s2 / p_km).sqrt();
+        let cos_ta_ecc = ta_rad.cos() + ecc;
+        let sin_ta = ta_rad.sin();
 
         let vx = sqrt_gm_p * cos_ta_ecc * (-sin_aop * cos_raan - cos_inc * sin_raan * cos_aop)
             - sqrt_gm_p * sin_ta * (cos_aop * cos_raan - cos_inc * sin_raan * sin_aop);
@@ -149,31 +149,31 @@ impl Orbit {
     /// Attempts to create a new Orbit from the provided radii of apoapsis and periapsis, in kilometers
     #[allow(clippy::too_many_arguments)]
     pub fn try_keplerian_apsis_radii(
-        r_a: f64,
-        r_p: f64,
-        inc: f64,
-        raan: f64,
-        aop: f64,
-        ta: f64,
+        r_a_km: f64,
+        r_p_km: f64,
+        inc_deg: f64,
+        raan_deg: f64,
+        aop_deg: f64,
+        ta_deg: f64,
         epoch: Epoch,
         frame: Frame,
     ) -> PhysicsResult<Self> {
         ensure!(
-            r_a > f64::EPSILON,
+            r_a_km > f64::EPSILON,
             RadiusSnafu {
                 action: "radius of apoapsis is negative"
             }
         );
         ensure!(
-            r_p > f64::EPSILON,
+            r_p_km > f64::EPSILON,
             RadiusSnafu {
                 action: "radius of periapsis is negative"
             }
         );
         // The two checks above ensure that sma > 0
-        let sma = (r_a + r_p) / 2.0;
-        let ecc = r_a / sma - 1.0;
-        Self::try_keplerian(sma, ecc, inc, raan, aop, ta, epoch, frame)
+        let sma = (r_a_km + r_p_km) / 2.0;
+        let ecc = r_a_km / sma - 1.0;
+        Self::try_keplerian(sma, ecc, inc_deg, raan_deg, aop_deg, ta_deg, epoch, frame)
     }
 
     /// Attempts to create a new Orbit around the provided frame from the borrowed state vector
@@ -196,31 +196,37 @@ impl Orbit {
     /// One should expect these errors to be on the order of 1e-12.
     #[allow(clippy::too_many_arguments)]
     pub fn keplerian(
-        sma: f64,
+        sma_km: f64,
         ecc: f64,
-        inc: f64,
-        raan: f64,
-        aop: f64,
-        ta: f64,
+        inc_deg: f64,
+        raan_deg: f64,
+        aop_deg: f64,
+        ta_deg: f64,
         epoch: Epoch,
         frame: Frame,
     ) -> Self {
-        Self::try_keplerian(sma, ecc, inc, raan, aop, ta, epoch, frame).unwrap()
+        Self::try_keplerian(
+            sma_km, ecc, inc_deg, raan_deg, aop_deg, ta_deg, epoch, frame,
+        )
+        .unwrap()
     }
 
     /// Creates a new Orbit from the provided radii of apoapsis and periapsis, in kilometers
     #[allow(clippy::too_many_arguments)]
     pub fn keplerian_apsis_radii(
-        r_a: f64,
-        r_p: f64,
-        inc: f64,
-        raan: f64,
-        aop: f64,
-        ta: f64,
+        r_a_km: f64,
+        r_p_km: f64,
+        inc_deg: f64,
+        raan_deg: f64,
+        aop_deg: f64,
+        ta_deg: f64,
         epoch: Epoch,
         frame: Frame,
     ) -> Self {
-        Self::try_keplerian_apsis_radii(r_a, r_p, inc, raan, aop, ta, epoch, frame).unwrap()
+        Self::try_keplerian_apsis_radii(
+            r_a_km, r_p_km, inc_deg, raan_deg, aop_deg, ta_deg, epoch, frame,
+        )
+        .unwrap()
     }
 
     /// Initializes a new orbit from the Keplerian orbital elements using the mean anomaly instead of the true anomaly.
diff --git a/anise/src/errors.rs b/anise/src/errors.rs
@@ -191,8 +191,8 @@ pub enum PhysicsError {
     },
     #[snafu(display("parabolic orbits are physically impossible and the eccentricity calculated to be within {limit:e} of 1.0"))]
     ParabolicEccentricity { limit: f64 },
-    #[snafu(display("parabolic orbits are physically impossible and the semilatus rectum (semi-parameter) calculated to be {p}"))]
-    ParabolicSemiParam { p: f64 },
+    #[snafu(display("parabolic orbits are physically impossible and the semilatus rectum (semi-parameter) calculated to be {p_km} km"))]
+    ParabolicSemiParam { p_km: f64 },
     #[snafu(display("hyperbolic true anomaly is physically impossible: {ta_deg} deg"))]
     HyperbolicTrueAnomaly { ta_deg: f64 },
     #[snafu(display("calculation requires hyperbolic orbit, but its eccentricity is {ecc}"))]
diff --git a/anise/src/frames/frameuid.rs b/anise/src/frames/frameuid.rs
@@ -8,6 +8,8 @@
  * Documentation: https://nyxspace.com/
  */
 
+use serde::{Deserialize, Serialize};
+
 use crate::{
     constants::{
         celestial_objects::celestial_name_from_id, orientations::orientation_name_from_id,
@@ -20,10 +22,7 @@ pub use super::Frame;
 
 /// A unique frame reference that only contains enough information to build the actual Frame object.
 /// It cannot be used for any computations, is it be used in any structure apart from error structures.
-///
-/// # Usage note
-/// You should almost always prefer Frame over FrameRef unless you will
-#[derive(Copy, Clone, Debug, PartialEq, Eq)]
+#[derive(Copy, Clone, Debug, PartialEq, Eq, Serialize, Deserialize)]
 pub struct FrameUid {
     pub ephemeris_id: NaifId,
     pub orientation_id: NaifId,
diff --git a/anise/src/math/rotation/quaternion.rs b/anise/src/math/rotation/quaternion.rs
@@ -16,6 +16,7 @@ use core::fmt;
 use core::ops::Mul;
 use der::{Decode, Encode, Reader, Writer};
 use nalgebra::Matrix4x3;
+use serde::{Deserialize, Serialize};
 use snafu::ensure;
 
 use super::EPSILON_RAD;
@@ -54,7 +55,7 @@ pub type Quaternion = EulerParameter;
 ///
 /// # Usage
 /// Importantly, ANISE prevents the composition of two Euler Parameters if the frames do not match.
-#[derive(Clone, Copy, Debug)]
+#[derive(Clone, Copy, Debug, Serialize, Deserialize)]
 pub struct EulerParameter {
     pub w: f64,
     pub x: f64,
diff --git a/anise/src/structure/dataset/mod.rs b/anise/src/structure/dataset/mod.rs
@@ -545,7 +545,6 @@ mod dataset_ut {
     fn spacecraft_constants_lookup() {
         // Build some data first.
         let full_sc = SpacecraftData {
-            name: "full spacecraft".try_into().unwrap(),
             srp_data: Some(SRPData {
                 area_m2: 2.0,
                 coeff_reflectivity: 1.8,
@@ -563,7 +562,6 @@ mod dataset_ut {
             drag_data: Some(DragData::default()),
         };
         let srp_sc = SpacecraftData {
-            name: "SRP only spacecraft".try_into().unwrap(),
             srp_data: Some(SRPData::default()),
             ..Default::default()
         };
@@ -690,7 +688,6 @@ mod dataset_ut {
     fn spacecraft_constants_lookup_builder() {
         // Build some data first.
         let full_sc = SpacecraftData {
-            name: "full spacecraft".try_into().unwrap(),
             srp_data: Some(SRPData {
                 area_m2: 2.0,
                 coeff_reflectivity: 1.8,
@@ -708,7 +705,6 @@ mod dataset_ut {
             drag_data: Some(DragData::default()),
         };
         let srp_sc = SpacecraftData {
-            name: "SRP only spacecraft".try_into().unwrap(),
             srp_data: Some(SRPData::default()),
             ..Default::default()
         };
diff --git a/anise/src/structure/spacecraft/drag.rs b/anise/src/structure/spacecraft/drag.rs
@@ -8,8 +8,9 @@
  * Documentation: https://nyxspace.com/
  */
 use der::{Decode, Encode, Reader, Writer};
+use serde_derive::{Deserialize, Serialize};
 
-#[derive(Copy, Clone, Debug, PartialEq)]
+#[derive(Copy, Clone, Debug, PartialEq, Serialize, Deserialize)]
 pub struct DragData {
     /// Atmospheric drag area in m^2
     pub area_m2: f64,
diff --git a/anise/src/structure/spacecraft/inertia.rs b/anise/src/structure/spacecraft/inertia.rs
@@ -9,11 +9,12 @@
  */
 use der::{Decode, Encode, Reader, Writer};
 use nalgebra::Matrix3;
+use serde_derive::{Deserialize, Serialize};
 
 use crate::NaifId;
 
 /// Inertial tensor definition
-#[derive(Copy, Clone, Debug, Default, PartialEq)]
+#[derive(Copy, Clone, Debug, Default, PartialEq, Serialize, Deserialize)]
 pub struct Inertia {
     /// Inertia tensor reference frame hash
     pub orientation_id: NaifId,
diff --git a/anise/src/structure/spacecraft/mass.rs b/anise/src/structure/spacecraft/mass.rs
diff --git a/anise/src/structure/spacecraft/mod.rs b/anise/src/structure/spacecraft/mod.rs
diff --git a/anise/src/structure/spacecraft/srp.rs b/anise/src/structure/spacecraft/srp.rs
diff --git a/anise/tests/orientations/mod.rs b/anise/tests/orientations/mod.rs
diff --git a/data/latest.dhall b/data/latest.dhall

Original file line number	Diff line number	Diff line change
`@@ -147,7 +147,7 @@ impl MetaFile {`
`147`	`147`	`self.uri = dest_path_s;`
`148`	`148`	`return Ok(());`
`149`	`149`	`} else {`
`150`		`- info!("Discarding cached {dest_path_s} - CRC32 differ (got {computed_crc32:x}, expected {crc32:x})");`
	`150`	`+ info!("Discarding cached {dest_path_s} - CRC32 differ (got 0x{computed_crc32:x}, expected 0x{crc32:x})");`
`151`	`151`	`}`
`152`	`152`	`}`
`153`	`153`	`}`
`@@ -206,7 +206,7 @@ impl MetaFile {`
`206`	`206`	`file.write_all(&bytes).unwrap();`
`207`	`207`
`208`	`208`	`info!(`
`209`		`- "Saved {url} to {} (CRC32 = {crc32:x})",`
	`209`	`+ "Saved {url} to {} (CRC32 = 0x{crc32:x})",`
`210`	`210`	`dest_path.to_str().unwrap()`
`211`	`211`	`);`
`212`	`212`
Original file line number	Diff line number	Diff line change
`@@ -144,7 +144,7 @@ mod meta_test {`
`144`	`144`	`, { crc32 = Some 0x8213b6e9`
`145`	`145`	`, uri = "http://public-data.nyxspace.com/anise/v0.5/pck11.pca"`
`146`	`146`	`}`
`147`		`- , { crc32 = Some 0x6f0ad74c`
	`147`	`+ , { crc32 = Some 0x21633903`
`148`	`148`	`, uri = "http://public-data.nyxspace.com/anise/v0.5/moon_fk_de440.epa"`
`149`	`149`	`}`
`150`	`150`	`, { crc32 = Some 0xcde5ca7d`