Merge branch 'develop' into GEOPY-2770

# Conflicts:
#	simpeg_drivers/plate_simulation/driver.py

Author: domfournier

simpeg_drivers-assets/uijson/tdem1d_forward.ui.json

@@ -39,7 +39,8 @@
     "z_channel_bool": {
         "group": "Survey",
         "main": true,
-        "label": "Z component",
+        "label": "Vertical",
+        "tooltip": "Vertical (w) component of the magnetic data",
         "value": true
     },
     "u_cell_size": {

simpeg_drivers-assets/uijson/tdem1d_inversion.ui.json

@@ -45,7 +45,8 @@
         "group": "Data",
         "dataGroupType": "Multi-element",
         "main": true,
-        "label": "z-component",
+        "label": "Vertical",
+        "tooltip": "Vertical (w) component of the magnetic data",
         "parent": "data_object",
         "optional": true,
         "enabled": true,

simpeg_drivers-assets/uijson/tdem_forward.ui.json

@@ -58,22 +58,25 @@
         ],
         "value": "dB/dt (T/s)"
     },
-    "z_channel_bool": {
+    "vertical_channel_bool": {
         "group": "Survey",
         "main": true,
-        "label": "Z component",
+        "label": "Vertical",
+        "tooltip": "Vertical (w) component of the magnetic data.\nPositive up along the z-axis if no receiver orientation provided",
         "value": true
     },
-    "x_channel_bool": {
+    "inline_channel_bool": {
         "group": "Survey",
         "main": true,
-        "label": "X component",
+        "label": "In-line",
+        "tooltip": "In-line (u) component of the magnetic data.\nPositive towards North if no receiver orientation provided",
         "value": true
     },
-    "y_channel_bool": {
+    "crossline_channel_bool": {
         "group": "Survey",
         "main": true,
-        "label": "Y component",
+        "label": "Cross-line",
+        "tooltip": "Cross-line (v) component of the magnetic data.\nPositive towards East if no receiver orientation provided",
         "value": true
     },
     "mesh": {

simpeg_drivers-assets/uijson/tdem_inversion.ui.json

@@ -58,7 +58,7 @@
         ],
         "value": "dB/dt (T/s)"
     },
-    "z_channel": {
+    "vertical_channel": {
         "association": [
             "Cell",
             "Vertex"
@@ -67,13 +67,14 @@
         "group": "Data",
         "dataGroupType": "Multi-element",
         "main": true,
-        "label": "z-component",
+        "label": "Vertical",
         "parent": "data_object",
+        "tooltip": "Vertical (w) component of the magnetic data.\nPositive up along the z-axis if no receiver orientation provided",
         "optional": true,
         "enabled": true,
         "value": ""
     },
-    "z_uncertainty": {
+    "vertical_uncertainty": {
         "association": [
             "Cell",
             "Vertex"
@@ -84,11 +85,11 @@
         "main": true,
         "label": "Uncertainty",
         "parent": "data_object",
-        "dependency": "z_channel",
+        "dependency": "vertical_channel",
         "dependencyType": "enabled",
         "value": ""
     },
-    "x_channel": {
+    "inline_channel": {
         "association": [
             "Cell",
             "Vertex"
@@ -97,13 +98,14 @@
         "group": "Data",
         "dataGroupType": "Multi-element",
         "main": true,
-        "label": "x-component",
+        "label": "In-line",
         "parent": "data_object",
+        "tooltip": "In-line (u) component of the magnetic data.\nPositive towards North if no receiver orientation provided",
         "optional": true,
         "enabled": false,
         "value": ""
     },
-    "x_uncertainty": {
+    "inline_uncertainty": {
         "association": [
             "Cell",
             "Vertex"
@@ -114,11 +116,11 @@
         "main": true,
         "label": "Uncertainty",
         "parent": "data_object",
-        "dependency": "x_channel",
+        "dependency": "inline_channel",
         "dependencyType": "enabled",
         "value": ""
     },
-    "y_channel": {
+    "crossline_channel": {
         "association": [
             "Cell",
             "Vertex"
@@ -127,13 +129,14 @@
         "group": "Data",
         "dataGroupType": "Multi-element",
         "main": true,
-        "label": "y-component",
+        "label": "Cross-line",
+        "tooltip": "Cross-line (v) component of the magnetic data.\nPositive towards East if no receiver orientation provided",
         "parent": "data_object",
         "optional": true,
         "enabled": false,
         "value": ""
     },
-    "y_uncertainty": {
+    "crossline_uncertainty": {
         "association": [
             "Cell",
             "Vertex"
@@ -144,7 +147,7 @@
         "main": true,
         "label": "Uncertainty",
         "parent": "data_object",
-        "dependency": "y_channel",
+        "dependency": "crossline_channel",
         "dependencyType": "enabled",
         "value": ""
     },

simpeg_drivers/components/data.py

@@ -309,9 +309,7 @@ def get_normalizations(self):
                     "tdem" in self.params.inversion_type
                     and "dB/dt" in self.params.data_units
                 ):
-                    if comp in ["x", "y", "z"]:
-                        normalizations[chan][comp] = -1
-                    normalizations[chan][comp] *= np.ones(self.mask.sum())
+                    normalizations[chan][comp] = np.full(self.mask.sum(), -1)
 
         return normalizations
 

simpeg_drivers/components/factories/receiver_factory.py

@@ -30,6 +30,13 @@
 from simpeg_drivers.utils.regularization import direction_and_dip, get_cell_normals
 
 
+ORIENTATION_MAP = {
+    "vertical": "z",
+    "inline": "y",
+    "crossline": "x",
+}
+
+
 class ReceiversFactory(SimPEGFactory):
     """Build SimPEG receivers objects based on factory type."""
 
@@ -150,14 +157,16 @@ def assemble_keyword_arguments(
 
         if self.factory_type in ["fdem", "fdem 1d", "magnetotellurics", "tipper"]:
             comp = component.split("_")[0]
-            kwargs["orientation"] = comp[0] if "fdem" in self.factory_type else comp[1:]
+            kwargs["orientation"] = (
+                ORIENTATION_MAP[comp] if "fdem" in self.factory_type else comp[1:]
+            )
             kwargs["component"] = component.split("_")[1]
 
         if self.factory_type in ["tipper"]:
             kwargs["orientation"] = kwargs["orientation"][::-1]
 
         if "tdem" in self.factory_type:
-            kwargs["orientation"] = component
+            kwargs["orientation"] = ORIENTATION_MAP[component]
 
         if self.factory_type == "fdem 1d":
             kwargs["data_type"] = "ppm"

simpeg_drivers/driver.py

@@ -14,10 +14,7 @@
 from __future__ import annotations
 
 from abc import abstractmethod, ABC
-import cProfile
-import pstats
 
-import contextlib
 from copy import deepcopy
 import sys
 from datetime import datetime, timedelta
@@ -26,7 +23,7 @@
 from time import time
 
 import numpy as np
-from dask.distributed import get_client, Client, LocalCluster, performance_report
+from dask.distributed import get_client, Client
 
 from geoapps_utils.base import Driver, Options
 from geoapps_utils.run import load_ui_json_as_dict
@@ -74,7 +71,7 @@
 from simpeg_drivers.joint.options import BaseJointOptions
 from simpeg_drivers.utils.nested import tile_locations
 from simpeg_drivers.utils.regularization import cell_neighbors, set_rotated_operators
-from simpeg_drivers.utils.utils import validate_out_group
+from simpeg_drivers.utils.utils import validate_out_group, start_dask_run
 
 mlogger = logging.getLogger("distributed")
 mlogger.setLevel(logging.WARNING)
@@ -500,47 +497,7 @@ def start_dask_run(
         :param n_workers: Number of workers to use.
         :param n_threads: Number of threads to use.
         """
-        ui_json = load_ui_json_as_dict(json_path)
-
-        n_workers = ui_json.get("n_workers", n_workers)
-        n_threads = ui_json.get("n_threads", n_threads)
-        save_report = ui_json.get("performance_report", False)
-
-        if (n_workers is not None and n_workers > 1) or n_threads is not None:
-            cluster = LocalCluster(
-                processes=True,
-                n_workers=n_workers,
-                threads_per_worker=n_threads,
-            )
-        else:
-            cluster = None
-
-        profiler = cProfile.Profile()
-        profiler.enable()
-
-        with (
-            cluster.get_client()
-            if cluster is not None
-            else contextlib.nullcontext() as context_client
-        ):
-            # Full run
-            with (
-                performance_report(filename=json_path.parent / "dask_profile.html")
-                if (save_report and isinstance(context_client, Client))
-                else contextlib.nullcontext()
-            ):
-                cls.start(json_path)
-                sys.stdout.close()
-
-        profiler.disable()
-
-        if save_report:
-            with open(
-                json_path.parent / "runtime_profile.txt", encoding="utf-8", mode="w"
-            ) as s:
-                ps = pstats.Stats(profiler, stream=s)
-                ps.sort_stats("cumulative")
-                ps.print_stats()
+        start_dask_run(cls, json_path, n_workers=n_workers, n_threads=n_threads)
 
     @property
     def workers(self) -> list[tuple[str]]: