goad-py 1.2.2__tar.gz → 1.3.0__tar.gz

{goad_py-1.2.2 → goad_py-1.3.0}/Cargo.lock

@@ -753,7 +753,7 @@ dependencies = [
 
 [[package]]
 name = "goad"
-version = "1.2.2"
+version = "1.3.0"
 dependencies = [
  "anyhow",
  "chrono",
@@ -1505,6 +1505,7 @@ dependencies = [
  "indoc",
  "libc",
  "memoffset",
+ "num-complex",
  "once_cell",
  "portable-atomic",
  "pyo3-build-config",

{goad_py-1.2.2 → goad_py-1.3.0}/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
     name = "goad"
-    version = "1.2.2"
+    version = "1.3.0"
     edition = "2021"
     license = "GPL-3.0"
     description = "Compute the single scattering properties of particles much larger than the wavelength of light with geometric optics and aperture diffraction theory."
@@ -25,7 +25,7 @@ readme = "README.md"
     ndarray = "0.15"
     num-complex = { version = "0.4.6", features = ["serde"] }
     numpy = "0.27.0"
-    pyo3 = { version = "0.27.1"}
+    pyo3 = { version = "0.27.1", features = ["num-complex"] }
     pyo3-stub-gen = { version = "0.17", optional = true }
     rand = "0.9.0"
     rand_distr = "0.5.1"

{goad_py-1.2.2 → goad_py-1.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: goad-py
-Version: 1.2.2
+Version: 1.3.0
 Classifier: Development Status :: 4 - Beta
 Classifier: Intended Audience :: Science/Research
 Classifier: Topic :: Scientific/Engineering :: Physics

{goad_py-1.2.2 → goad_py-1.3.0}/examples/backscattering/main.rs

@@ -3,6 +3,7 @@
 //! Run with: cargo run --release --example backscattering
 
 use goad::convergence::Convergence;
+use goad::geom::Geom;
 use goad::params::Param;
 use goad::settings;
 use std::path::PathBuf;
@@ -16,9 +17,7 @@ fn main() -> anyhow::Result<()> {
 
     // Load settings from defaults and override
     let mut settings = settings::load_default_config()?;
-    settings.geom_name = geometry_file.to_string_lossy().to_string();
     settings.wavelength = 0.532;
-    settings.particle_refr_index = vec![nalgebra::Complex::new(1.31, 0.0)];
     settings.zones = vec![]; // empty zones for backscatter only
     settings.max_tir = 20;
     settings.beam_area_threshold_fac = 0.01;
@@ -27,8 +26,14 @@ fn main() -> anyhow::Result<()> {
     settings.directory = output_dir.clone();
     settings.quiet = false;
 
+    // Load geometry with its refractive index
+    let geoms = Geom::load(
+        geometry_file.to_str().expect("non-utf8 geometry path"),
+        vec![nalgebra::Complex::new(1.31, 0.0)],
+    )?;
+
     // Create convergence solver
-    let mut convergence = Convergence::new(None, Some(settings))?;
+    let mut convergence = Convergence::new(geoms, Some(settings))?;
 
     // Add targets: 5% error on lidar ratio and depolarization ratio
     convergence.add_target(Param::LidarRatio, 0.05);

{goad_py-1.2.2 → goad_py-1.3.0}/examples/backscattering/run_ensemble.py

@@ -3,7 +3,7 @@
 import json
 from pathlib import Path
 
-from goad import Convergence, Param, Settings
+from goad import Convergence, Geom, Param, Settings
 
 base_dir = Path(__file__).parent
 ensemble_dir = base_dir / "ensemble"
@@ -11,11 +11,9 @@ results_dir = base_dir / "ensemble_results"
 results_dir.mkdir(exist_ok=True)
 
 # Pass the directory containing all OBJ files for ensemble averaging
+geoms = Geom.from_file(str(ensemble_dir), [1.31 + 0j])
 settings = Settings(
-    geom_path=str(ensemble_dir),
     wavelength=0.532,
-    particle_refr_index_re=1.31,
-    particle_refr_index_im=0.0,
     zones=[],
     max_tir=20,
     directory=str(results_dir),
@@ -24,7 +22,7 @@ settings = Settings(
     cutoff=0.999,
 )
 
-convergence = Convergence(settings)
+convergence = Convergence(settings, geoms)
 convergence.add_target(Param.LidarRatio, 0.1)
 convergence.add_target(Param.DepolarizationRatio, 0.1)
 convergence.add_target(Param.BackscatterCross, 0.1)

{goad_py-1.2.2 → goad_py-1.3.0}/examples/backscattering/run_individual.py

@@ -3,7 +3,7 @@
 import json
 from pathlib import Path
 
-from goad import Convergence, Param, Settings
+from goad import Convergence, Geom, Param, Settings
 
 base_dir = Path(__file__).parent
 ensemble_dir = base_dir / "ensemble"
@@ -24,11 +24,9 @@ for i, geometry_file in enumerate(obj_files):
     particle_dir = results_dir / f"particle_{i + 1}"
     particle_dir.mkdir(exist_ok=True)
 
+    geoms = Geom.from_file(str(geometry_file), [1.31 + 0j])
     settings = Settings(
-        geom_path=str(geometry_file),
         wavelength=0.532,
-        particle_refr_index_re=1.31,
-        particle_refr_index_im=0.0,
         zones=[],
         max_tir=20,
         directory=str(particle_dir),
@@ -37,7 +35,7 @@ for i, geometry_file in enumerate(obj_files):
         cutoff=0.999,
     )
 
-    convergence = Convergence(settings)
+    convergence = Convergence(settings, geoms)
     convergence.add_target(Param.LidarRatio, 0.1)
     convergence.add_target(Param.DepolarizationRatio, 0.1)
     convergence.add_target(Param.BackscatterCross, 0.1)

{goad_py-1.2.2 → goad_py-1.3.0}/examples/backscattering/run_roughness_sweep.py

@@ -3,7 +3,7 @@
 import json
 from pathlib import Path
 
-from goad import Convergence, Param, Settings
+from goad import Convergence, Geom, Param, Settings
 
 base_dir = Path(__file__).parent
 
@@ -20,11 +20,9 @@ for sigma in roughness_levels:
     print(f"Running ensemble for sigma={sigma}")
     print(f"{'=' * 60}")
 
+    geoms = Geom.from_file(str(ensemble_dir), [1.31 + 0j])
     settings = Settings(
-        geom_path=str(ensemble_dir),
         wavelength=0.532,
-        particle_refr_index_re=1.31,
-        particle_refr_index_im=0.0,
         zones=[],
         max_tir=20,
         directory=str(results_dir),
@@ -33,7 +31,7 @@ for sigma in roughness_levels:
         cutoff=0.999,
     )
 
-    convergence = Convergence(settings)
+    convergence = Convergence(settings, geoms)
     convergence.add_target(Param.LidarRatio, 0.025)
     convergence.add_target(Param.DepolarizationRatio, 0.025)
     convergence.add_target(Param.BackscatterCross, 0.025)

{goad_py-1.2.2 → goad_py-1.3.0}/examples/backscattering/run_simulation.py

@@ -2,7 +2,7 @@
 
 from pathlib import Path
 
-from goad import Convergence, Param, Settings
+from goad import Convergence, Geom, Param, Settings
 
 output_dir = Path(__file__).parent
 
@@ -12,16 +12,15 @@ geometry_file = (
     / "roughened_edge15.0_sigma0p1_merge1p0_hexagonal_column_l5.0_r25.0_6904c8.obj"
 )
 
+# Load geometry with the ice refractive index
+geoms = Geom.from_file(str(geometry_file), [1.31 + 0j])
+
 # Set up simulation settings
 # - wavelength 0.532 microns (green laser)
-# - ice refractive index 1.31
 # - empty zones for faster computation (just forward and backward scattering)
 # - high max_tir for backscattering
 settings = Settings(
-    geom_path=str(geometry_file),
     wavelength=0.532,
-    particle_refr_index_re=1.31,
-    particle_refr_index_im=0.0,
     zones=[],
     max_tir=20,
     directory=str(output_dir),
@@ -31,7 +30,7 @@ settings = Settings(
 )
 
 # Set up convergence solver
-convergence = Convergence(settings)
+convergence = Convergence(settings, geoms)
 
 # Converge on lidar ratio and depolarisation ratio within 10% error
 convergence.add_target(Param.LidarRatio, 0.1)

{goad_py-1.2.2 → goad_py-1.3.0}/examples/capture_vertices.rs

@@ -1,5 +1,6 @@
 use goad::clip::Clipping;
-use goad::geom::{Geom, Face};
+use goad::geom::{Face, Geom};
+use goad::settings::DEFAULT_PARTICLE_REFR_INDEX;
 use nalgebra::{Point3, Vector3};
 
 fn main() {
@@ -23,7 +24,7 @@ fn main() {
 }
 
 fn test_projection_debug() {
-    let geoms = Geom::load("./examples/data/hex.obj").unwrap();
+    let geoms = Geom::load("./examples/data/hex.obj", vec![DEFAULT_PARTICLE_REFR_INDEX]).unwrap();
     let mut geom = geoms[0].clone();
     let mut clip = geom.shapes[0].faces.remove(4);
     let projection = Vector3::new(0.0, 0.0, -1.0);
@@ -35,7 +36,7 @@ fn test_projection_debug() {
 }
 
 fn test_projection1() {
-    let geoms = Geom::load("./examples/data/concave1.obj").unwrap();
+    let geoms = Geom::load("./examples/data/concave1.obj", vec![DEFAULT_PARTICLE_REFR_INDEX]).unwrap();
     let mut geom = geoms[0].clone();
     let mut clip = geom.shapes[0].faces.remove(4);
     let projection = Vector3::new(-0.3, 0.0, -1.0);
@@ -47,7 +48,7 @@ fn test_projection1() {
 }
 
 fn test_projection2() {
-    let geoms = Geom::load("./examples/data/cube_inside_ico.obj").unwrap();
+    let geoms = Geom::load("./examples/data/cube_inside_ico.obj", vec![DEFAULT_PARTICLE_REFR_INDEX]).unwrap();
     let mut geom = geoms[0].clone();
     let mut clip = geom.shapes[0].faces.remove(5);
     let projection = Vector3::new(-0.2, 0.0, -1.0);
@@ -59,7 +60,7 @@ fn test_projection2() {
 }
 
 fn test_projection_multi() {
-    let geoms = Geom::load("./examples/data/multiple.obj").unwrap();
+    let geoms = Geom::load("./examples/data/multiple.obj", vec![DEFAULT_PARTICLE_REFR_INDEX]).unwrap();
     let mut geom = geoms[0].clone();
     let mut clip = geom.shapes[0].faces.remove(5);
     let projection = Vector3::new(-1.0, 0.0, 0.0);
@@ -71,7 +72,7 @@ fn test_projection_multi() {
 }
 
 fn test_clip_test() {
-    let geoms = Geom::load("./examples/data/clip_test.obj").unwrap();
+    let geoms = Geom::load("./examples/data/clip_test.obj", vec![DEFAULT_PARTICLE_REFR_INDEX]).unwrap();
     let mut geom = geoms[0].clone();
     let mut clip = geom.shapes[1].faces.remove(1);
     let projection = Vector3::new(1.0, 1.0, 0.0);
@@ -83,7 +84,7 @@ fn test_clip_test() {
 }
 
 fn test_remainder() {
-    let geoms = Geom::load("./examples/data/multiple.obj").unwrap();
+    let geoms = Geom::load("./examples/data/multiple.obj", vec![DEFAULT_PARTICLE_REFR_INDEX]).unwrap();
     let mut geom = geoms[0].clone();
     let projection = Vector3::new(0.0, 0.0, -1.0);
     

{goad_py-1.2.2 → goad_py-1.3.0}/examples/convergence.rs

@@ -1,15 +1,17 @@
 // --8<-- [start:convergence]
 fn main() {
     use goad::convergence::Convergence;
+    use goad::geom::Geom;
     use goad::params::Param;
     use goad::result::GOComponent;
-    use goad::settings;
+    use goad::settings::{self, DEFAULT_PARTICLE_REFR_INDEX};
 
-    // Load default settings
+    // Load default settings and geometry
     let settings = settings::load_default_config().unwrap();
+    let geoms = Geom::load("./examples/data/hex.obj", vec![DEFAULT_PARTICLE_REFR_INDEX]).unwrap();
 
     // Create a convergence solver
-    let mut convergence = Convergence::new(None, Some(settings)).unwrap();
+    let mut convergence = Convergence::new(geoms, Some(settings)).unwrap();
 
     // Set convergence target: 1% relative SEM on asymmetry parameter
     convergence.add_target(Param::Asymmetry, 0.03);

{goad_py-1.2.2 → goad_py-1.3.0}/examples/distortion.rs

@@ -1,5 +1,7 @@
 use goad::cancel::CancelToken;
+use goad::geom::Geom;
 use goad::problem::Problem;
+use goad::settings::DEFAULT_PARTICLE_REFR_INDEX;
 
 // --8<-- [start:multiproblem]
 fn main() {
@@ -9,14 +11,16 @@ fn main() {
     let mut base_settings = settings::load_default_config().unwrap();
     base_settings.quiet = true;
     // base_settings.geom_scale = Some(vec![2.622, 2.622, 3.745]);
-    base_settings.geom_name = "examples/data/hex.obj".to_string();
 
     let distortions = vec![0.1];
 
     for distortion in distortions {
         let mut settings = base_settings.clone();
         settings.distortion = Some(distortion);
-        let mut problem = Problem::new(None, Some(settings)).unwrap();
+        let geom = Geom::load("examples/data/hex.obj", vec![DEFAULT_PARTICLE_REFR_INDEX])
+            .unwrap()
+            .remove(0);
+        let mut problem = Problem::new(geom, Some(settings)).unwrap();
         let _ = problem.run(None, &CancelToken::noop());
         let _ = problem.geom.write_obj(format!("file_{}.obj", distortion));
         let _ = problem.writeup();

goad_py-1.3.0/examples/field_at_initial_beam.rs

@@ -0,0 +1,84 @@
+//! Sample the near-field at a handful of query points along the initial
+//! incident beam.
+//!
+//! Runs a recorded solve on a hex geometry, filters the recording down to
+//! just the initial illumination event, then asks `BeamView::fields_at`
+//! for the field contribution at each query point.
+//!
+//! `settings.scale = Some(1.0)` opts out of the automatic rescale-to-unit-
+//! cube that `Problem::init` would otherwise apply, so query points and
+//! reported distances are in the same units as the geometry file.
+
+use goad::beam::BeamVariant;
+use goad::cancel::CancelToken;
+use goad::geom::Geom;
+use goad::problem::Problem;
+use goad::settings::{load_default_config, DEFAULT_PARTICLE_REFR_INDEX};
+use nalgebra::Point3;
+
+fn main() {
+    // 1. Load default settings and pin the scale so the geometry isn't
+    //    rescaled. Coordinates below are then in the hex.obj's native
+    //    units (vertices at z = ±5, hex radius ≈ 5).
+    let mut settings = load_default_config().expect("load default config");
+    settings.scale = Some(1.0);
+
+    let geoms = Geom::load("./examples/data/hex.obj", vec![DEFAULT_PARTICLE_REFR_INDEX])
+        .expect("load hex");
+    let geom = geoms[0].clone();
+    let mut problem = Problem::new(geom, Some(settings)).expect("build problem");
+
+    // 2. Run the full recorded pipeline (init → orient → illuminate →
+    //    near-field with recording → far-field → mueller → params).
+    //    `None` for euler → no rotation; geometry sits as loaded.
+    let recording = problem
+        .run_with_recording(None, &CancelToken::noop())
+        .expect("recorded solve");
+
+    println!("recorded {} propagation events", recording.len());
+
+    // 3. Filter the view to just the initial illumination event.
+    let view = recording.view().variant(BeamVariant::Initial);
+    let initial_events: Vec<_> = view.events().collect();
+    println!("initial events in view: {}", initial_events.len());
+
+    // 4. Pick a few query points. The default illumination travels along
+    //    -z from a quad above the geometry. With FAC=1.1 in
+    //    basic_initial_beam and hex top at z = 5, the illumination face
+    //    sits at z ≈ 5.5, so the initial beam's column spans
+    //    z ∈ [5.0, 5.5]. We sample inside that slab, plus two negative
+    //    controls (upstream of the start, off-footprint in xy).
+    let query_points = vec![
+        Point3::new(0.0, 0.0, 5.4),  // inside the initial slab, near start
+        Point3::new(0.0, 0.0, 5.2),  // inside, mid-slab
+        Point3::new(0.0, 0.0, 5.05), // inside, near front cap
+        Point3::new(0.0, 0.0, 10.0), // upstream of illumination — outside
+        Point3::new(0.0, 0.0, 0.0),  // inside the geometry — past front cap
+        Point3::new(20.0, 0.0, 5.2), // off the illumination footprint in xy
+    ];
+
+    let results = view.fields_at(&query_points);
+
+    // 5. Report per-point contributions.
+    for (i, contribs) in results.iter().enumerate() {
+        let p = &query_points[i];
+        println!(
+            "\npoint ({:.3}, {:.3}, {:.3}): {} contribution(s)",
+            p.x,
+            p.y,
+            p.z,
+            contribs.len()
+        );
+        for c in contribs {
+            println!(
+                "  event {} output {} kind={:?} distance={:.4} intensity={:.4e} phase={:.4}",
+                c.event_id,
+                c.output_index,
+                c.kind,
+                c.distance,
+                c.field.intensity(),
+                c.field.phase(),
+            );
+        }
+    }
+}

{goad_py-1.2.2 → goad_py-1.3.0}/examples/lidar_batch_test.rs

@@ -5,6 +5,7 @@ use std::path::PathBuf;
 use std::time::Instant;
 
 use goad::convergence::Convergence;
+use goad::geom::Geom;
 use goad::orientation::{EulerConvention, Orientation, Scheme};
 use goad::params::Param;
 use goad::result::GOComponent;
@@ -52,8 +53,6 @@ fn run_single_config(
     let settings = Settings {
         wavelength: WAVELENGTH_UM,
         medium_refr_index: Complex::new(1.0, 0.0),
-        particle_refr_index: vec![Complex::new(REFR_INDEX_RE, REFR_INDEX_IM)],
-        geom_name: geom_dir.to_string_lossy().to_string(),
         zones: vec![], // Empty zones = auto Forward/Backward
         max_tir: MAX_TIR,
         max_rec: 10,
@@ -66,7 +65,7 @@ fn run_single_config(
             euler_convention: EulerConvention::ZYZ,
         },
         seed: None,
-        scale: 1.0,
+        scale: Some(1.0),
         distortion: None,
         geom_scale: None,
         fov_factor: None,
@@ -86,8 +85,15 @@ fn run_single_config(
         binning: None,
     };
 
+    // Load all geometries in the directory with the configured refractive index
+    let geoms = Geom::load(
+        geom_dir.to_str().ok_or("non-utf8 geom dir")?,
+        vec![Complex::new(REFR_INDEX_RE, REFR_INDEX_IM)],
+    )
+    .map_err(|e| e.to_string())?;
+
     // Create convergence solver
-    let mut convergence = Convergence::new(None, Some(settings)).map_err(|e| e.to_string())?;
+    let mut convergence = Convergence::new(geoms, Some(settings)).map_err(|e| e.to_string())?;
 
     // Enable logging
     let log_file = results_dir.join("convergence_log.csv");

{goad_py-1.2.2 → goad_py-1.3.0}/examples/lidar_convergence_test.rs

@@ -3,10 +3,11 @@
 
 fn main() {
     use goad::convergence::Convergence;
+    use goad::geom::Geom;
     use goad::orientation::{Orientation, Scheme};
     use goad::params::Param;
     use goad::result::GOComponent;
-    use goad::settings;
+    use goad::settings::{self, DEFAULT_PARTICLE_REFR_INDEX};
 
     // Initialize logging
     env_logger::Builder::from_env(env_logger::Env::default().default_filter_or("info")).init();
@@ -23,8 +24,11 @@ fn main() {
         euler_convention: settings.orientation.euler_convention,
     };
 
+    // Load default geometry separately (geom no longer lives in Settings)
+    let geoms = Geom::load("examples/data/hex.obj", vec![DEFAULT_PARTICLE_REFR_INDEX]).unwrap();
+
     // Create a convergence solver
-    let mut convergence = Convergence::new(None, Some(settings)).unwrap();
+    let mut convergence = Convergence::new(geoms, Some(settings)).unwrap();
 
     // Enable logging of mean values during convergence
     convergence.set_log_file("lidar_convergence_running.csv");

{goad_py-1.2.2 → goad_py-1.3.0}/examples/multiproblem.rs

@@ -1,10 +1,12 @@
 // --8<-- [start:multiproblem]
 fn main() {
     use goad::multiproblem::MultiProblem;
-    use goad::settings;
+    use goad::settings::{self, cli};
 
     // Setup and run a multi-orientation problem with default settings
-    let mut multiproblem = MultiProblem::new(None, settings::load_config().ok()).unwrap();
+    let settings = settings::load_config().ok();
+    let geoms = cli::load_geoms().expect("load geoms");
+    let mut multiproblem = MultiProblem::new(geoms, settings).unwrap();
     multiproblem.solve();
 }
 // --8<-- [end:multiproblem]

{goad_py-1.2.2 → goad_py-1.3.0}/examples/problem-diff.rs

@@ -1,15 +1,18 @@
 use goad::cancel::CancelToken;
 use goad::geom::{self};
 use goad::problem::Problem;
+use goad::settings::DEFAULT_PARTICLE_REFR_INDEX;
 
 fn main() {
-    let geoms = geom::Geom::load("./examples/data/concave2.obj").unwrap();
+    let geoms =
+        geom::Geom::load("./examples/data/concave2.obj", vec![DEFAULT_PARTICLE_REFR_INDEX])
+            .unwrap();
     let mut geom = geoms[0].clone();
 
     geom.shapes[0].refr_index.re = 1.31;
     geom.shapes[0].refr_index.im = 0.001;
 
-    let mut problem = Problem::new(Some(geom), None).unwrap();
+    let mut problem = Problem::new(geom, None).unwrap();
     problem.geom.write_obj("hex_hollow_rot.obj").unwrap();
 
     println!("Resetting problem...");

{goad_py-1.2.2 → goad_py-1.3.0}/examples/problem1.rs

@@ -1,15 +1,17 @@
 use goad::cancel::CancelToken;
 use goad::geom::{self};
 use goad::problem::Problem;
+use goad::settings::DEFAULT_PARTICLE_REFR_INDEX;
 
 fn main() {
-    let geoms = geom::Geom::load("./examples/data/hex2.obj").unwrap();
+    let geoms =
+        geom::Geom::load("./examples/data/hex2.obj", vec![DEFAULT_PARTICLE_REFR_INDEX]).unwrap();
     let mut geom = geoms[0].clone();
 
     geom.shapes[0].refr_index.re = 1.5;
     geom.shapes[0].refr_index.im = 0.0001;
 
-    let mut problem = Problem::new(Some(geom), None).unwrap();
+    let mut problem = Problem::new(geom, None).unwrap();
 
     problem.solve_near(&CancelToken::noop()).unwrap();
 }

{goad_py-1.2.2 → goad_py-1.3.0}/examples/regen_mueller_refs/main.rs

@@ -43,7 +43,8 @@ fn main() {
         }
         wrote_any = true;
         let settings = (case.build_settings)();
-        let mut mp = MultiProblem::new(None, Some(settings))
+        let geoms = (case.build_geoms)();
+        let mut mp = MultiProblem::new(geoms, Some(settings))
             .expect("Failed to create MultiProblem");
         mp.solve();