GEOPY-2779: Add Leroi as option for engine inside Plate Simulation application by benk-mira · Pull Request #378 · MiraGeoscience/simpeg-drivers

benk-mira · 2026-04-15T22:10:11Z

GEOPY-2779 - Add Leroi as option for engine inside Plate Simulation application

…lder with conftest.py added to ensure the PATH variable is accessible in pytest runs).

for more information, see https://pre-commit.ci

Copilot

Pull request overview

Adds an initial (toggleable) path for running plate simulations via a LeroiAir-based workflow, alongside early interface/options scaffolding and related tests/UI wiring.

Changes:

Introduces a use_leroi option (Python + UI JSON) intended to switch plate simulation execution to a LeroiAir driver for TEM forward runs.
Adds initial leroi_air options/interface/driver modules under simpeg_drivers/plate_simulation/leroi_air/.
Adds new test scaffolding and a pytest fixture to help resolve executables on PATH in IDE-driven runs.

Reviewed changes

Copilot reviewed 13 out of 13 changed files in this pull request and generated 15 comments.

Show a summary per file

File	Description
tests/plate_simulation/runtest/leroi_test.py	Adds Leroi-related runtime tests (currently incomplete).
tests/plate_simulation/runtest/conftest.py	Adds session fixture to prepend conda `Scripts/` to PATH.
tests/plate_simulation/leroi_air/options_test.py	Adds assertions around newly introduced LeroiAir options behavior.
tests/plate_simulation/leroi_air/interface_test.py	Placeholder for interface tests (header-only).
tests/plate_simulation/leroi_air/driver_test.py	Placeholder for driver tests (currently incomplete).
tests/plate_simulation/leroi_air/init.py	Provides helper to generate `LeroiAirOptions` for tests.
simpeg_drivers/plate_simulation/options.py	Adds `use_leroi` flag to plate simulation options.
simpeg_drivers/plate_simulation/leroi_air/options.py	Introduces `LeroiAirOptions` dataclass and derived properties.
simpeg_drivers/plate_simulation/leroi_air/interface.py	Adds CFL formatting/writing interface for LeroiAir (scaffolding).
simpeg_drivers/plate_simulation/leroi_air/driver.py	Adds a LeroiAir driver stub (currently inconsistent with options/interface).
simpeg_drivers/plate_simulation/leroi_air/init.py	Initializes the new `leroi_air` package (header-only).
simpeg_drivers/plate_simulation/driver.py	Wires `use_leroi` toggle into driver selection logic.
simpeg_drivers-assets/uijson/plate_simulation.ui.json	Adds UI control for `use_leroi`.

Comments suppressed due to low confidence (1)

tests/plate_simulation/runtest/leroi_test.py:22

test_leroi_run has no function body, which will raise an IndentationError during test collection. Add a body (e.g., implement assertions or at least pass/pytest.skip(...)) so the test module imports cleanly.

def test_leroi_run(tmp_path):

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

# Conflicts: # tests/plate_simulation/models/plates_test.py

Copilot

Pull request overview

Copilot reviewed 19 out of 19 changed files in this pull request and generated 9 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-04-21T19:46:02Z

+    def run(self) -> None:
+        """Write input, run LeroiAir, and save simulated data to geoh5."""
+        self.interface.write_cfl_file(self.project_path / "LeroiAir.cfl")
+        self.run_leroi()
+        self.interface.save_to_geoh5(
+            outfile=self.project_path / "LeroiAir.out",
+            out_group=self.out_group,
+        )


LeroiAirDriver.run() passes self.out_group into save_to_geoh5, but out_group defaults to None. If a caller forgets to set it, this will fail with a non-obvious attribute error inside save_to_geoh5. Add an explicit check (and raise a clear exception) when out_group is not set.

To Copilot's comment, you should validate/set the out_group in the init of the driver. Check the simpeg_drivers.BaseDriver mechanics...

This is out of date. I'm passing self.options.out_group now which is treated the same as in simpeg_drivers.BaseDriver (ie: it can't be none).

self.options.out_group can be None, it is typed as such. The base driver uses self.out_group which is validated/created in the init

ok, I changed the typing of Options.out_group. In the context of a plate-simulation run, the out group can never be None since it is initialized in plate-simulation driver:

and passed into the options class on construction:

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

… into GEOPY-2779

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

…model as required by simpeg runs

domfournier

Good progress. See comments, but also check the runtest for the gravity. Looks like the model is being generated inside the mesh of the forward. The forward driver should not do operation on his own.

Co-authored-by: domfournier <dominiquef@mirageoscience.com>

# Conflicts: # simpeg_drivers/plate_simulation/driver.py # simpeg_drivers/plate_simulation/options.py # simpeg_drivers/utils/utils.py

…aved on plate-simulation mesh and starting_model saved on forward mesh. Fix mesh naming

benk-mira · 2026-04-24T16:52:24Z

Good progress. See comments, but also check the runtest for the gravity. Looks like the model is being generated inside the mesh of the forward. The forward driver should not do operation on his own.

Fixed the structure.

…f of interface class

domfournier

Getting there.
Can you review the comments, but also take a look at the failing test. We should NOT try to run the exe for now, just do it locally.

domfournier · 2026-04-27T19:02:23Z

+        """Extract channel data for a single component from a LeroiAir .out file."""
+        lines = Path(outfile).read_text(encoding="utf-8", errors="replace").splitlines()
+        data_lines = self._slice_data_lines(lines, self._COMPONENT_ANCHORS[component])
+        return np.array([line.split() for line in data_lines], dtype=float)[:, 4:]


This is where the unit conversion should occur if needed.

Not sure what you intended here. The unit conversion is in time. I handled this by adding back in properties on the LeroiAirOptions for channels, timing_mark, and waveform, and applying the conversion to milliseconds that LeroiAir expects.

As long as it comes back in SI like SimPEG, then you can ignore.

SI, with a nT -> T required:

domfournier · 2026-04-27T19:07:04Z

+            layer_thicknesses=[model.overburden_options.thickness, 9999],
+            plate_resistivities=[model.plate_options.plate_property],
+            plate_geometries=[model.plate_options.geometry],
+            magnetic_field="dBdt" if "dBdt" in simulation.data_units else "B",


Why not preserving the name and values of data_units?

it's just a flag to run leroi air in STEP=0 or 1 so I didn't think it was necessary, I simplified to just take a bool.

domfournier · 2026-04-27T19:13:20Z

+    def run(self) -> None:
+        """Write input, run LeroiAir, and save simulated data to geoh5."""
+        self.interface.write_cfl_file(self.project_path / "LeroiAir.cfl")
+        self.run_leroi()
+        self.interface.save_to_geoh5(
+            outfile=self.project_path / "LeroiAir.out",
+            out_group=self.out_group,
+        )


To Copilot's comment, you should validate/set the out_group in the init of the driver. Check the simpeg_drivers.BaseDriver mechanics...

codecov · 2026-04-28T21:59:11Z

Codecov Report

❌ Patch coverage is 92.04545% with 28 lines in your changes missing coverage. Please review.
✅ Project coverage is 90.36%. Comparing base (749ec6c) to head (5191acb).

Files with missing lines	Patch %	Lines
...eg_drivers/plate_simulation/leroi_air/interface.py	92.36%	9 Missing and 2 partials ⚠️
simpeg_drivers/plate_simulation/driver.py	84.21%	6 Missing and 3 partials ⚠️
...mpeg_drivers/plate_simulation/leroi_air/options.py	95.79%	5 Missing ⚠️
...impeg_drivers/plate_simulation/leroi_air/driver.py	85.00%	2 Missing and 1 partial ⚠️

Additional details and impacted files

@@             Coverage Diff             @@
##           develop     #378      +/-   ##
===========================================
+ Coverage    90.26%   90.36%   +0.10%     
===========================================
  Files          132      135       +3     
  Lines         6469     6765     +296     
  Branches       814      822       +8     
===========================================
+ Hits          5839     6113     +274     
- Misses         420      439      +19     
- Partials       210      213       +3

Files with missing lines	Coverage Δ
simpeg_drivers/plate_simulation/options.py	`100.00% <100.00%> (+12.12%)`	⬆️
simpeg_drivers/utils/utils.py	`66.77% <ø> (ø)`
...impeg_drivers/plate_simulation/leroi_air/driver.py	`85.00% <85.00%> (ø)`
...mpeg_drivers/plate_simulation/leroi_air/options.py	`95.79% <95.79%> (ø)`
simpeg_drivers/plate_simulation/driver.py	`88.81% <84.21%> (-4.16%)`	⬇️
...eg_drivers/plate_simulation/leroi_air/interface.py	`92.36% <92.36%> (ø)`

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

… to milliseconds if survey.unit is not ms

…tion

domfournier · 2026-04-30T17:03:16Z

+    def run(self) -> None:
+        """Write input, run LeroiAir, and save simulated data to geoh5."""
+        self.interface.write_cfl_file(self.project_path / "LeroiAir.cfl")
+        self.run_leroi()
+        self.interface.save_to_geoh5(
+            outfile=self.project_path / "LeroiAir.out",
+            out_group=self.out_group,
+        )


self.options.out_group can be None, it is typed as such. The base driver uses self.out_group which is validated/created in the init

domfournier · 2026-04-30T17:11:48Z

+    def record_2(self) -> str:
+        return self.format_line(["TDFD", "DO3D", "PRFL", "ISTOP"])


Would you mind adding docstrings for all of these. Just a translation of the code from the docs.

domfournier · 2026-04-30T17:12:23Z

+        """Extract channel data for a single component from a LeroiAir .out file."""
+        lines = Path(outfile).read_text(encoding="utf-8", errors="replace").splitlines()
+        data_lines = self._slice_data_lines(lines, self._COMPONENT_ANCHORS[component])
+        return np.array([line.split() for line in data_lines], dtype=float)[:, 4:]


As long as it comes back in SI like SimPEG, then you can ignore.

benk-mira added 5 commits April 8, 2026 09:26

test deployment strategy for leroi air (.exe in .conda-env/Scripts fo…

615ade0

…lder with conftest.py added to ensure the PATH variable is accessible in pytest runs).

update to run from .bat file with relative pathing

d763e45

Merge branch 'develop' into GEOPY-2779

190fe46

initial structure

26ea236

options tested

43f410e

Copilot AI review requested due to automatic review settings April 15, 2026 22:10

github-actions Bot changed the title ~~Geopy 2779~~ GEOPY-2779: Add Leroi as option for engine inside Plate Simulation application Apr 15, 2026

[pre-commit.ci] auto fixes from pre-commit.com hooks

1176e1d

for more information, see https://pre-commit.ci

Copilot started reviewing on behalf of benk-mira April 15, 2026 22:10 View session

Copilot AI reviewed Apr 15, 2026

View reviewed changes

benk-mira added 11 commits April 16, 2026 14:24

Filled in unit tests, working on runtest

77da1d5

cleanup

f899e41

fix plate tests for new origin convention

9f851e1

bulk up unit tests for options class

58c7956

Update the runtests

551e8af

don't create mesh or model if use_leroi

3a07436

Merge branch 'develop' into GEOPY-2779

8bc8ef4

# Conflicts: # tests/plate_simulation/models/plates_test.py

simplify and remove _organize_out_group

999e985

Merge branch 'develop' into GEOPY-2779

71e10eb

Add Maxwell Plate creation for non-leroi runs

45e4202

Results in the right place: foward group under plate_simulation group

16e9eec

benk-mira requested a review from Copilot April 21, 2026 19:39

Copilot started reviewing on behalf of benk-mira April 21, 2026 19:40 View session

Copilot AI reviewed Apr 21, 2026

View reviewed changes

benk-mira and others added 6 commits April 21, 2026 13:02

Update tests/plate_simulation/runtest/leroi_test.py

8c792fc

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

fix save_to_geoh5 to handle n channels

49ad967

Merge branch 'GEOPY-2779' of github.com:MiraGeoscience/simpeg-drivers…

c57f22a

… into GEOPY-2779

Update simpeg_drivers/plate_simulation/options.py

f7739bc

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Update simpeg_drivers/plate_simulation/leroi_air/interface.py

c69414c

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

initialize simulation_parameters on construction with lazy load mesh/…

602eca4

…model as required by simpeg runs

domfournier reviewed Apr 23, 2026

View reviewed changes

Comment thread simpeg_drivers/plate_simulation/driver.py Outdated

benk-mira and others added 3 commits April 24, 2026 08:13

Update simpeg_drivers/plate_simulation/leroi_air/__init__.py

b9c8ac6

Co-authored-by: domfournier <dominiquef@mirageoscience.com>

Merge branch 'develop' into GEOPY-2779

8221bf5

# Conflicts: # simpeg_drivers/plate_simulation/driver.py # simpeg_drivers/plate_simulation/options.py # simpeg_drivers/utils/utils.py

forward and plate-simulation each get a copy of octree with geology s…

2c1f4e1

…aved on plate-simulation mesh and starting_model saved on forward mesh. Fix mesh naming

even better organization for simpeg runs

00153a3

benk-mira closed this Apr 24, 2026

benk-mira reopened this Apr 24, 2026

benk-mira added 5 commits April 24, 2026 10:21

cleanup

517ce5f

split the interface class into input and output classes

207a532

refactor leroi options to limit scope of options passed to output hal…

b66248e

…f of interface class

title as field

e860349

clean up all the fetch_active_workspace calls

337b00b

domfournier reviewed Apr 27, 2026

View reviewed changes

benk-mira added 3 commits April 27, 2026 13:49

use leroi -> UseLeroiAir

5d3dbea

fix copyrights

2587551

try to bypass github run of leroi test only

3bb7798

benk-mira added 9 commits April 28, 2026 15:11

remove survey derived properties in favor of direct access

3241db3

improve docstrings

f6f8a8f

undo disable protected-access for all tests

bea6cf4

disable protected-access on pylint for interface_test

f194b2a

also driver_test

3af27d6

Convert any timing parameters (timing_mark, channeld, waveform[:, 0])…

33e39bc

… to milliseconds if survey.unit is not ms

add normalization to convert nT -> T, and simplify dbdt/b field selec…

9605442

…tion

remove todo for time unit conversion

8b1818d

fix test

5191acb

domfournier reviewed Apr 30, 2026

View reviewed changes

out_group is not optional for options class

33bcc43

		def record_2(self) -> str:
		return self.format_line(["TDFD", "DO3D", "PRFL", "ISTOP"])

Conversation

benk-mira commented Apr 15, 2026 • edited by github-actions Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI Apr 21, 2026

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

domfournier left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

benk-mira commented Apr 24, 2026

Uh oh!

domfournier left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

codecov Bot commented Apr 28, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

benk-mira commented Apr 15, 2026 •

edited by github-actions Bot

Loading

codecov Bot commented Apr 28, 2026 •

edited

Loading