WIP spice feature and ground based obs

Cargo.toml

@@ -53,6 +53,7 @@ dunce = "1.0"
 uom = "0.35"
 regex = "1.10"
 kalast_macros = { path = "macros", version = "0.4.0-beta" }
+strum = { version = "0.25", features = ["derive"] }
 
 [dev-dependencies]
 rstest = "0.18"

examples/ground-based-lightcurve-didymos-spice/cfg/cfg.yaml

@@ -8,11 +8,13 @@ simulation:
   export:
     step: 60
     duration: 8136
+  pause_after_first_iteration: true
 
 scene:
-  spice: true
+  spice: /Users/gregoireh/data/spice/dart/mk/d420.tm
   camera:
-    !earth 2.0
+    from: Earth
+    distance: 2
 
 bodies:
   - id: Didymos

examples/viewer/cfg/cfg.yaml

@@ -1,4 +1,4 @@
-win:
+window:
   ambient: [0.1, 0.1, 0.1]
 
 bodies:

preferences.yaml

@@ -0,0 +1 @@
+no_check: true

src/body/asteroid.rs

@@ -85,11 +85,11 @@ impl AirlessBody {
     }
 }
 
-pub fn matrix_spin(spin: Float) -> Mat4 {
+pub fn matrix_spin(spin: Float, axis: Vec3) -> Mat4 {
     if spin == 0.0 {
         Mat4::identity()
     } else {
-        Mat4::new_rotation(spin * Vec3::z())
+        Mat4::new_rotation(spin * axis)
     }
 }
 

src/cfg/body.rs

@@ -531,6 +531,9 @@ pub enum CfgState {
 
     #[serde(rename = "file")]
     File(PathBuf),
+
+    #[serde(rename = "spice")]
+    Spice(CfgStateSpice),
 }
 
 impl CfgState {
@@ -757,6 +760,18 @@ impl Default for CfgOrbitSpeedControl {
     }
 }
 
+#[derive(Clone, Debug, Serialize, Deserialize)]
+pub struct CfgStateSpice {
+    #[serde(default)]
+    pub origin: Option<String>,
+
+    #[serde(default)]
+    pub frame: Option<String>,
+
+    #[serde(default)]
+    pub frame_to: Option<String>,
+}
+
 /**
 # Configuration of the Initialisation of the Temperature of the Body.
 

src/cfg/config.rs

@@ -1,4 +1,4 @@
-use crate::{CfgBody, CfgBodyError, CfgPreferences, CfgScene, CfgSimulation, CfgWindow};
+use crate::{CfgBody, CfgBodyError, CfgPreferences, CfgScene, CfgSimulation, CfgSpice, CfgWindow};
 
 use itertools::Itertools;
 use serde::{de::DeserializeOwned, Deserialize, Serialize};
@@ -168,6 +168,10 @@ pub struct Cfg {
     #[serde(default)]
     pub simulation: CfgSimulation,
 
+    #[cfg(feature = "spice")]
+    #[serde(default)]
+    pub spice: CfgSpice,
+
     #[serde(default)]
     pub window: CfgWindow,
 
@@ -292,6 +296,10 @@ impl Cfg {
     pub fn extra(&self) -> &HashMap<String, Value> {
         &self.extra
     }
+
+    pub fn using_spice(&self) -> bool {
+        self.scene.spice.is_some()
+    }
 }
 
 impl Configuration for Cfg {}
@@ -303,6 +311,10 @@ impl Default for Cfg {
             bodies: vec![],
             scene: CfgScene::default(),
             simulation: CfgSimulation::default(),
+
+            #[cfg(feature = "spice")]
+            spice: CfgSpice::default(),
+
             window: CfgWindow::default(),
             preferences: CfgPreferences::default(),
             extra: HashMap::new(),

src/cfg/mod.rs

@@ -56,11 +56,13 @@ mod config;
 mod preferences;
 mod scene;
 mod simulation;
+mod spice;
 mod window;
 
 pub use body::*;
 pub use config::*;
 pub use preferences::*;
 pub use scene::*;
 pub use simulation::*;
+pub use spice::*;
 pub use window::*;

src/cfg/preferences.rs

@@ -10,6 +10,7 @@ pub struct CfgPreferences {
     pub runs: PathBuf,
 
     #[serde(default)]
+    #[serde(alias = "no_check")]
     pub do_not_check_latest_version: bool,
 
     #[serde(default)]
@@ -28,8 +29,8 @@ impl Default for CfgPreferences {
     fn default() -> Self {
         Self {
             runs: default_runs(),
-            auto_update: false,
             do_not_check_latest_version: false,
+            auto_update: false,
             debug: false,
             debug_cfg: false,
         }

src/cfg/scene.rs

@@ -1,9 +1,9 @@
-use std::path::PathBuf;
-
-use crate::{util::*, CfgBodyError, CfgStateCartesian, Configuration, Equatorial};
+use crate::{util::*, CfgBodyError, Configuration, Equatorial};
 
 use serde::{Deserialize, Serialize};
 use snafu::{prelude::*, Location};
+use std::path::PathBuf;
+use strum::{Display, EnumString};
 
 pub type SceneResult<T, E = CfgSceneError> = std::result::Result<T, E>;
 
@@ -41,57 +41,92 @@ impl Default for CfgScene {
 impl Configuration for CfgScene {}
 
 #[derive(Clone, Debug, Serialize, Deserialize)]
+#[serde(untagged)]
 pub enum CfgCamera {
     #[serde(rename = "position")]
     Position(Vec3),
 
     /// Camera in from the direction of the Sun (Sun behind camera).
     /// The float is the distance from the center of frame to the camera.
-    #[serde(rename = "sun")]
-    Sun(Float),
-
-    #[serde(rename = "earth")]
-    Earth(Float),
+    ///
+    /// TODO: COMPLETE DOC
+    #[serde(rename = "from")]
+    From(CfgCameraFrom),
 }
 
 impl CfgCamera {
-    pub fn as_earth(&self) -> SceneResult<Float> {
-        match self {
-            Self::Earth(distance) => Ok(*distance),
-            _ => panic!("Not in Earth mode."),
-        }
+    pub fn default_position() -> Vec3 {
+        Vec3::x() * 5.0
     }
 }
 
 impl Default for CfgCamera {
     fn default() -> Self {
-        Self::Sun(5.0)
+        Self::Position(Self::default_position())
+    }
+}
+
+#[derive(Clone, Debug, Serialize, Deserialize)]
+pub struct CfgCameraFrom {
+    #[serde(default)]
+    pub from: CfgCameraFromOptions,
+
+    #[serde(default)]
+    #[serde(alias = "distance")]
+    pub distance_origin: Float,
+}
+
+#[derive(Clone, Debug, Serialize, Deserialize, EnumString, Display)]
+pub enum CfgCameraFromOptions {
+    #[serde(rename = "sun")]
+    #[serde(alias = "Sun")]
+    Sun,
+
+    #[serde(rename = "earth")]
+    #[serde(alias = "Earth")]
+    Earth,
+}
+
+impl Default for CfgCameraFromOptions {
+    fn default() -> Self {
+        Self::Sun
     }
 }
 
 #[derive(Clone, Debug, Serialize, Deserialize)]
-#[serde(tag = "type")]
+#[serde(untagged)]
 pub enum CfgSun {
-    #[serde(rename = "cartesian")]
-    #[serde(alias = "cart")]
-    Cartesian(CfgStateCartesian),
+    #[serde(rename = "position")]
+    Position(Vec3),
 
     #[serde(rename = "equatorial")]
-    #[serde(alias = "astro")]
     Equatorial(Equatorial),
+
+    #[serde(rename = "from")]
+    From(CfgSunFrom),
 }
 
 impl CfgSun {
-    pub fn as_equatorial(&self) -> SceneResult<&Equatorial> {
-        match self {
-            Self::Equatorial(coords) => Ok(coords),
-            _ => panic!("Not equatorial coordinates."),
-        }
+    pub fn default_position() -> Vec3 {
+        Vec3::x() * Self::default_distance()
+    }
+
+    pub fn default_distance() -> Float {
+        1.0
     }
 }
 
 impl Default for CfgSun {
     fn default() -> Self {
-        Self::Cartesian(CfgStateCartesian::position_only(Vec3::x()))
+        Self::Position(Self::default_position())
     }
 }
+
+#[derive(Clone, Debug, Serialize, Deserialize)]
+pub enum CfgSunFrom {
+    #[serde(rename = "from_spice")]
+    Spice,
+
+    #[serde(rename = "from_orbit_body")]
+    OrbitBody,
+}

src/cfg/simulation.rs

@@ -8,7 +8,8 @@ pub type SimulationResult<T, E = CfgSimulationError> = std::result::Result<T, E>
 /// Errors related to Kalast config.
 #[derive(Debug, Snafu)]
 pub enum CfgSimulationError {
-    SpiceNotLoaded {},
+    #[snafu(display("Feature `spice` is not enabled."))]
+    FeatureSpiceNotEnabled {},
 }
 
 #[derive(Clone, Debug, Serialize, Deserialize)]
@@ -66,7 +67,7 @@ impl TimeOption {
                 #[cfg(feature = "spice")]
                 return Ok(spice::str2et(_s));
                 #[cfg(not(feature = "spice"))]
-                return Err(CfgSimulationError::SpiceNotLoaded {});
+                return Err(CfgSimulationError::FeatureSpiceNotEnabled {});
             }
         }
     }

src/cfg/spice.rs

@@ -0,0 +1,31 @@
+use crate::Configuration;
+
+use serde::{Deserialize, Serialize};
+use snafu::prelude::*;
+use std::path::PathBuf;
+
+pub type CfgSpiceResult<T, E = CfgSpiceError> = std::result::Result<T, E>;
+
+/// Errors related to Kalast config.
+#[derive(Debug, Snafu)]
+pub enum CfgSpiceError {}
+
+#[derive(Clone, Debug, Serialize, Deserialize)]
+pub struct CfgSpice {
+    #[serde(default)]
+    pub kernel: Option<PathBuf>,
+
+    #[serde(default)]
+    pub frame: Option<String>,
+}
+
+impl Default for CfgSpice {
+    fn default() -> Self {
+        Self {
+            kernel: None,
+            frame: None,
+        }
+    }
+}
+
+impl Configuration for CfgSpice {}

src/simu/export.rs

@@ -172,7 +172,7 @@ impl Export {
         CsvWriter::new(&mut file).finish(&mut df).unwrap();
 
         let mut df = df!(
-            "sunpos" => scene.sun_pos.as_slice(),
+            "sunpos" => scene.sun.as_slice(),
         )
         .unwrap();
         let mut file = std::fs::File::options()