groove schema refactor (#181)

* update docs * add groove types and simplify ASDF Type name and class association * define WELDX_TAG_BASE * add __post_init__ methods * add pint dimensionality check decorator * add ureg_check_class decorator * accept multiple arguments and add docstring * add `# noinspection PyUnresolvedReferences` flags for false positive PyCharm dataclass docstring errors * dynamically create type mapping * move parameter mapping to class * update dcostring format * update get_groove docstring * directory refactor * update API and ASDF documentation * update changelog * move GmawProcess classes * reorder inits
BAMWelDX · Nov 9, 2020 · 4f89569 · 4f89569
1 parent 8fea706
commit 4f89569
Show file tree

Hide file tree

Showing 45 changed files with 1,338 additions and 1,427 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -5,6 +5,21 @@
 - Added `weldx.utility.ureg_check_class` class decorator to enable `pint` dimensionality checks with `@dataclass`. [[#179]](https://github.com/BAMWelDX/weldx/pull/179)
 - Made coordinates and orientations optional for LCS schema. Missing values are interpreted as unity translation/rotation. An empty LCS object represents a unity transformation step. [[#177]](https://github.com/BAMWelDX/weldx/pull/177)
 
+### changes
+- refactor welding groove classes [[#181]](https://github.com/BAMWelDX/weldx/pull/181)
+  - refactor groove codebase to make use of subclasses and classnames for more generic functions
+  - add `_meta` attribute to subclasses that map class attributes (dataclass parameters) to common names
+  - rework `get_groove` to make use of new class layout and parse function arguments
+- create `weldx.welding` module (contains GMAW processes and groove definitions) [[#181]](https://github.com/BAMWelDX/weldx/pull/181)
+- move `GmawProcessTypeAsdf` to `asdf.tags` folder [[#181]](https://github.com/BAMWelDX/weldx/pull/181)
+- reorder module imports in `weldx.__init__` [[#181]](https://github.com/BAMWelDX/weldx/pull/181)
+
+### ASDF
+- refactor ISO 9692-1 groove schema definitions and classes [[#181]](https://github.com/BAMWelDX/weldx/pull/181)
+  - move base schema definitions in file `terms-1.0.0.yaml` to `weldx/groove`
+  - split old schema into multiple files (1 per groove type) and create folder `iso_9692_1_2013_12`
+
+
 ## 0.2.1 (26.10.2020)
 ### changes
 - Documentation

diff --git a/doc/api.rst b/doc/api.rst
@@ -17,6 +17,7 @@ API
     weldx.transformations
     weldx.utility
     weldx.visualization
+    weldx.welding
 
 
 **ASDF modules**

diff --git a/doc/asdf-schemas.rst b/doc/asdf-schemas.rst
@@ -9,3 +9,4 @@ ASDF Schema Definitions
     schemas/measurement.rst
     schemas/process.rst
     schemas/time.rst
+    schemas/groove.rst
diff --git a/doc/conf.py b/doc/conf.py
@@ -6,8 +6,8 @@
 
 # Local build command ------------------------------------------------------------------
 
-# sphinx-build -W -n -b html -D nbsphinx_kernel_name="weldx" -D nbsphinx_execute="never"
-# -d build/doctrees doc build/html --keep-going
+# sphinx-build -W -n -b html -d build/doctrees doc build/html --keep-going
+# -D nbsphinx_kernel_name="weldx" -D nbsphinx_execute="never"
 
 # -- Path setup --------------------------------------------------------------
 
@@ -23,6 +23,7 @@
 import traitlets
 
 import weldx
+from weldx.asdf.constants import WELDX_TAG_BASE
 
 sys.path.insert(0, os.path.abspath(""))
 
@@ -180,7 +181,7 @@
         "http://asdf-standard.readthedocs.io/en/latest/generated/stsci.edu/asdf/",
     ),
     (
-        "tag:weldx.bam.de:weldx",
+        WELDX_TAG_BASE,
         "http://weldx.readthedocs.io/en/latest/generated/weldx.bam.de/weldx/",
     ),
 ]

diff --git a/doc/schemas/core.rst b/doc/schemas/core.rst
@@ -9,7 +9,6 @@ The ``core`` directory contains schema implementations for the base classes.
     core/time_series-1.0.0
     core/variable-1.0.0
     core/dimension-1.0.0
-    core/iso_groove-1.0.0
     core/data_array-1.0.0
     core/dataset-1.0.0
 

diff --git a/doc/schemas/groove.rst b/doc/schemas/groove.rst
@@ -0,0 +1,29 @@
+Grooves
+=======
+
+The ``groove`` directory contains reference implementations of welding groove definitions for different standards.
+
+Common Terms
+############
+
+.. asdf-autoschemas::
+
+    groove/terms-1.0.0
+
+DIN EN ISO 9692-1
+#################
+
+.. asdf-autoschemas::
+
+    groove/iso_9692_1_2013_12/DHUGroove-1.0.0
+    groove/iso_9692_1_2013_12/DHVGroove-1.0.0
+    groove/iso_9692_1_2013_12/DUGroove-1.0.0
+    groove/iso_9692_1_2013_12/DVGroove-1.0.0
+    groove/iso_9692_1_2013_12/FFGroove-1.0.0
+    groove/iso_9692_1_2013_12/HUGroove-1.0.0
+    groove/iso_9692_1_2013_12/HVGroove-1.0.0
+    groove/iso_9692_1_2013_12/IGroove-1.0.0
+    groove/iso_9692_1_2013_12/UGroove-1.0.0
+    groove/iso_9692_1_2013_12/UVGroove-1.0.0
+    groove/iso_9692_1_2013_12/VGroove-1.0.0
+    groove/iso_9692_1_2013_12/VVGroove-1.0.0
diff --git a/scripts/aws_run.py b/scripts/aws_run.py
@@ -22,8 +22,8 @@
     ShieldingGasForProcedure,
 )
 from weldx.asdf.tags.weldx.aws.process.shielding_gas_type import ShieldingGasType
-from weldx.asdf.tags.weldx.core.iso_groove import get_groove
 from weldx.constants import WELDX_QUANTITY as Q_
+from weldx.welding.groove.iso_9692_1 import get_groove
 
 # welding process -----------------------------------------------------------------
 gas_comp = [

diff --git a/scripts/groove_load_script.py b/scripts/groove_load_script.py