Merge remote-tracking branch 'origin/master' into quality_standards

# Conflicts: # weldx/__init__.py # weldx/asdf/util.py
BAMWelDX · Mar 12, 2021 · b1f86e9 · b1f86e9
2 parents 8b14026 + 5cd7748
commit b1f86e9
Show file tree

Hide file tree

Showing 69 changed files with 5,049 additions and 3,751 deletions.
diff --git a/.github/workflows/pytest_asdf.yml b/.github/workflows/pytest_asdf.yml
@@ -8,7 +8,7 @@ jobs:
     strategy:
       matrix:
         os: [ubuntu-18.04]
-        py: ['3.8', '3.9']
+        py: ['3.8']
     steps:
       - uses: actions/checkout@v2
       - uses: actions/setup-python@v1

diff --git a/.github/workflows/static_analysis.yml b/.github/workflows/static_analysis.yml
@@ -9,7 +9,7 @@ jobs:
       fail-fast: false
       matrix:
         os: [ubuntu-latest]
-        py: ['3.8', '3.9']
+        py: ['3.8']
     steps:
       - uses: actions/checkout@v2
       - uses: actions/setup-python@v2
@@ -28,7 +28,7 @@ jobs:
       fail-fast: false
       matrix:
         os: [ubuntu-latest]
-        py: ['3.8', '3.9']
+        py: ['3.8']
     steps:
       - uses: actions/checkout@v2
       - uses: actions/setup-python@v2
@@ -48,7 +48,7 @@ jobs:
       fail-fast: false
       matrix:
         os: [ubuntu-latest]
-        py: ['3.8', '3.9']
+        py: ['3.8']
     steps:
       - uses: actions/checkout@v2
       - uses: actions/setup-python@v2

diff --git a/.typo-ci.yml b/.typo-ci.yml
@@ -30,12 +30,15 @@ excluded_words:
   - networkx
   - shutil
   - functools
+  - boltons
+  - meshio
   # matplotlib ----------------------------------
   - gca
   - mpl
   - ncols
   - plt
   - pyplot
+  - zorder
   # flake8 --------------------------------------
   - noqa
   - addopts
@@ -56,6 +59,7 @@ excluded_words:
   - ndarray
   - ndim
   - newaxis
+  - tolist
   - vstack
   # pandas / xarray -----------------------------
   - bfill
@@ -116,6 +120,9 @@ excluded_words:
   - numpydoc
   # markdown / latex ----------------------------
   - cdot
+  # file extensions -----------------------------
+  - vtk
+  - stl
   # other ---------------------------------------
   - addopts
   - csm
@@ -144,6 +151,7 @@ excluded_words:
   - tslibs
   - quickstart
   - nsecond
+  - iterutils
   # German ---------------------------------------
   - Bundesanstalt
   - für

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,15 +1,20 @@
 # Release Notes
 
-## 0.3.0 (unreleased)
+## 0.3.0 (12.03.2021)
 
 ### added
 
 - add `weldx.transformations.CoordinateSystemManager.relabel`
   function [[#219]](https://github.com/BAMWelDX/weldx/pull/219)
 - add `SpatialDate` class for storing 3D point data with optional
   triangulation [[#234]](https://github.com/BAMWelDX/weldx/pull/234)
-- add `plot` function to visualize `LocalCoordinateSystem` and `CoordinateSystemManager` instances in 3d space 
+- add `plot` function to `SpatialData`[[#251]](https://github.com/BAMWelDX/weldx/pull/251)
+- add `plot` function to visualize `LocalCoordinateSystem` and `CoordinateSystemManager` instances in 3d space
   [[#231]](https://github.com/BAMWelDX/weldx/pull/231)
+- add `weldx.welding.groove.iso_9692_1.IsoBaseGroove.cross_sect_area` property to compute cross sectional area between
+  the workpieces [[#248]](https://github.com/BAMWelDX/weldx/pull/248).
+- add `weldx.welding.util.compute_welding_speed` function [[#248]](https://github.com/BAMWelDX/weldx/pull/248).
+
 ### ASDF
 
 - Add possibility to store meta data and content of an external file in an ASDF
@@ -27,6 +32,14 @@
       as `custom_schema` when reading/writing `ASDF`-files
     - the `single_pass_weld-1.0.0.schema` is an example schema for a simple, linear, single pass GMAW application
     - add `core/geometry/point_cloud-1.0.0.yaml` schema [[#234]](https://github.com/BAMWelDX/weldx/pull/234)
+- add file schema describing a simple linear welding
+  application `datamodels/single_pass_weld-1.0.0.schema` [[#256]](https://github.com/BAMWelDX/weldx/pull/256)
+
+### documentation
+
+- Simplify tutorial code and enhance plots by using newly implemented plot functions
+  [[#231]](https://github.com/BAMWelDX/weldx/pull/231) [[#251]](https://github.com/BAMWelDX/weldx/pull/251)
+- add AWS shielding gas descriptions to documentation [[#270]](https://github.com/BAMWelDX/weldx/pull/270)
 
 ### changes
 
@@ -43,6 +56,13 @@
 - add `stack` option to most `geometry` classes for rasterization [[#234]](https://github.com/BAMWelDX/weldx/pull/234)
 - The graph of a `CoordinateSystemManager` is now plotted with `plot_graph` instead of `plot`.
   [[#231]](https://github.com/BAMWelDX/weldx/pull/231)
+- add custom `wx_shape` validation for `TimeSeries` and `Quantity` [[#256]](https://github.com/BAMWelDX/weldx/pull/256)
+- refactor the `transformations` and `visualization` module into smaller
+  files [[#247]](https://github.com/BAMWelDX/weldx/pull/247)
+- refactor `weldx.utility` into `weldx.util` [[#247]](https://github.com/BAMWelDX/weldx/pull/247)
+- refactor `weldx.asdf.utils` into `weldx.asdf.util` [[#247]](https://github.com/BAMWelDX/weldx/pull/247)
+- it is now allowed to merge a time-dependent `timedelta` subsystem into another `CSM` instance if the parent instance
+  has set an explicit reference time [[#268]](https://github.com/BAMWelDX/weldx/pull/268)
 
 ### fixes
 
@@ -53,14 +73,22 @@
 - fix deprecated signature in `WXRotation` [[#224]](https://github.com/BAMWelDX/weldx/pull/224)
 - fix a bug with singleton dimensions in xarray
   interpolation/matmul [[#243]](https://github.com/BAMWelDX/weldx/pull/243)
+- update some documentation formatting and links [[#247]](https://github.com/BAMWelDX/weldx/pull/247)
+- fix `wx_shape` validation for scalar `Quantity` and `TimeSeries`
+  objects [[#256]](https://github.com/BAMWelDX/weldx/pull/256)
+- fix a case where `CSM.time_union()` would return with mixed `DateTimeIndex` and `TimeDeltaIndex`
+  types [[#268]](https://github.com/BAMWelDX/weldx/pull/268)
 
 ### dependencies
 
 - Add [PyFilesystem](https://docs.pyfilesystem.org/en/latest/)(`fs`) as new dependency
 - Add [k3d](https://github.com/K3D-tools/K3D-jupyter) as new dependency
 - restrict `scipy<1.6`
   pending [ASDF #916](https://github.com/asdf-format/asdf/issues/916) [[#224]](https://github.com/BAMWelDX/weldx/pull/224)
-- set minimum Python version to 3.8 [[#229]](https://github.com/BAMWelDX/weldx/pull/229)[[#255]](https://github.com/BAMWelDX/weldx/pull/255)
+- set minimum Python version to
+  3.8 [[#229]](https://github.com/BAMWelDX/weldx/pull/229)[[#255]](https://github.com/BAMWelDX/weldx/pull/255)
+- only import some packages upon first use [[#247]](https://github.com/BAMWelDX/weldx/pull/247)
+- Add [meshio](https://pypi.org/project/meshio/) as new dependency [#265](https://github.com/BAMWelDX/weldx/pull/265)
 
 ## 0.2.2 (30.11.2020)
 

diff --git a/README.md b/README.md
@@ -25,8 +25,11 @@ division at Bundesanstalt für Materialforschung und -prüfung (BAM).
 
 ## Installation
 
-The WelDX package can be installed using conda from the `conda-forge` channel.
-
+The WelDX package can be installed using conda or mamba package manager from the :code:`conda-forge` channel.
+These managers originate from the freely available [Anaconda Python stack](https://docs.conda.io/en/latest/miniconda.html>).
+If you do not have Anaconda or Miniconda installed yet, we ask you to install ``Miniconda-3``.
+Documentation for the installation procedure can be found [here](https://docs.conda.io/projects/conda/en/latest/user-guide/install/index.html#regular-installation).
+After this step you have access to the conda command and can proceed to installing the WeldX package.
 ```console
 conda install weldx -c conda-forge
 ```

diff --git a/codecov.yml b/codecov.yml
@@ -25,4 +25,4 @@ coverage:
 ignore:
   - "tests"
   - "*__init__.py"
-  - "weldx/visualization.py"
+  - "weldx/visualization/*"
diff --git a/doc/_templates/module-template.rst b/doc/_templates/module-template.rst
@@ -14,28 +14,28 @@
    {% endif %}
    {% endblock %}
 
-   {% block functions %}
-   {% if functions %}
-   .. rubric:: {{ _('Functions') }}
+   {% block classes %}
+   {% if classes %}
+   .. rubric:: {{ _('Classes') }}
 
    .. autosummary::
       :toctree:
+      :template: class-template.rst
       :nosignatures:
-   {% for item in functions %}
+   {% for item in classes %}
       {{ item }}
    {%- endfor %}
    {% endif %}
    {% endblock %}
 
-   {% block classes %}
-   {% if classes %}
-   .. rubric:: {{ _('Classes') }}
+   {% block functions %}
+   {% if functions %}
+   .. rubric:: {{ _('Functions') }}
 
    .. autosummary::
       :toctree:
-      :template: class-template.rst
       :nosignatures:
-   {% for item in classes %}
+   {% for item in functions %}
       {{ item }}
    {%- endfor %}
    {% endif %}

diff --git a/doc/api.rst b/doc/api.rst
@@ -1,6 +1,5 @@
 API
-=================================
-
+===
 
 **Python modules**
 
@@ -15,7 +14,7 @@ API
     weldx.geometry
     weldx.measurement
     weldx.transformations
-    weldx.utility
+    weldx.util
     weldx.visualization
     weldx.welding
 
@@ -29,6 +28,6 @@ API
     :recursive:
 
     weldx.asdf.extension
-    weldx.asdf.utils
+    weldx.asdf.util
     weldx.asdf.validators
 
diff --git a/doc/conf.py b/doc/conf.py
@@ -22,11 +22,20 @@
 
 import traitlets
 
+# find weldx from parent path.
+sys.path.insert(0, os.path.abspath("../"))
+
+import typing
+
+import ipywidgets
+import pandas as _
+import xarray
+
+typing.TYPE_CHECKING = True
 import weldx
+import weldx.visualization  # load visualization
 from weldx.asdf.constants import WELDX_TAG_BASE
 
-sys.path.insert(0, os.path.abspath(""))
-
 # -- copy files to doc folder -------------------------------------------------
 doc_dir = pathlib.Path(".")
 changelog_file = pathlib.Path("./../CHANGELOG.md")
@@ -45,7 +54,7 @@
 author = "BAM"
 
 # The full version, including alpha/beta/rc tags
-release = weldx.__version__
+release = weldx.__version__ if weldx.__version__ else "undefined"
 
 # The name of the Pygments (syntax highlighting) style to use.
 pygments_style = "sphinx"
@@ -104,7 +113,7 @@
 napoleon_type_aliases = None
 
 # sphinx-autodoc-typehints https://github.com/agronholm/sphinx-autodoc-typehints
-set_type_checking_flag = False
+set_type_checking_flag = True
 typehints_fully_qualified = False
 always_document_param_types = False
 typehints_document_rtype = True
@@ -191,7 +200,9 @@
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 # This pattern also affects html_static_path and html_extra_path.
-exclude_patterns = ["**.ipynb_checkpoints"]
+exclude_patterns = [
+    "**.ipynb_checkpoints",
+]
 
 
 # -- Options for HTML output -------------------------------------------------

diff --git a/doc/index.rst b/doc/index.rst
@@ -27,11 +27,21 @@ The second main component is the the ``WelDX`` file standard that is used to def
 
 Installation
 ############
-The WelDX package can be installed using conda from the :code:`bamwelding` channel (with some required packages available on the :code:`conda-forge` channel).
+The WelDX package can be installed using conda or mamba package manager from the :code:`conda-forge` channel.
+These managers originate from the freely available `Anaconda Python stack <https://docs.conda.io/en/latest/miniconda.html>`_.
+If you do not have Anaconda or Miniconda installed yet, we ask you to install ``Miniconda-3``.
+Documentation for the installation procedure can be found `here <https://docs.conda.io/projects/conda/en/latest/user-guide/install/index.html#regular-installation>`_. After this step you have access to the conda command and can proceed to installing the WeldX package.
 
 ::
 
-    conda install weldx -c conda-forge -c bamwelding
+    conda install weldx -c conda-forge
+
+
+The package is also available on pypi.
+
+::
+
+    pip install weldx
 
 
 Funding

diff --git a/doc/nitpick_ignore b/doc/nitpick_ignore
@@ -27,6 +27,10 @@ py:class pint.quantity.Quantity
 py:class scipy.spatial.transform.rotation.Rotation
 py:class scipy.spatial.transform.Rotation
 
+# derived from scipy
+py:method weldx.transformations.WXRotation.from_mrp
+py:method weldx.transformations.WXRotation.random
+
 # sympy
 py:class sympy.core.expr.Expr
 

diff --git a/doc/schemas/aws.rst b/doc/schemas/aws.rst
@@ -0,0 +1,10 @@
+AWS
+===
+
+The ``AWS`` directory contains example implementations for shielding gas descriptions following NISTIR 7107.
+
+.. asdf-autoschemas::
+
+    aws/process/shielding_gas_for_procedure-1.0.0
+    aws/process/shielding_gas_type-1.0.0
+    aws/process/gas_component-1.0.0
diff --git a/doc/shape-validation.md b/doc/shape-validation.md
@@ -32,15 +32,15 @@ Each shape item follows these rules:
 
 * an ``Integer`` indicates a fix dimension for the same item
 
-* a ``~``, `:` or `None` indicates a single dimension of arbitrary length.
+* a ``~`` indicates a single dimension of arbitrary length.
 
 * a ``...`` indicates an arbitrary number of dimensions of arbitrary length, which can be optional.
 
 * a ``n`` indicates a single dimension fixed to an alphanumeric. So a string out of letters and numbers is allowed.
 
 * parenthesis ``(_)`` indicate that the dimension is optional. This can be combined with the other rules.
 
-* the symbols ``~`` or `:` furthermore add the option to implement an interval. This string `4~` would be an open
+* the symbols ``~`` furthermore add the option to implement an interval. This string `4~` would be an open
   interval that accepts all dimensions that are greater or equal to 4.
 
 ### Exceptions

diff --git a/doc/standard.rst b/doc/standard.rst
@@ -17,6 +17,7 @@ The WelDX standard consists of the following schema definitions:
     schemas/process.rst
     schemas/time.rst
     schemas/groove.rst
+    schemas/aws.rst
     schemas/datamodels.rst
 
 ASDF Extension

diff --git a/environment.yml b/environment.yml
@@ -17,6 +17,7 @@ dependencies:
   # - asdf>=2.7
   - openpyxl
   - fs
+  - meshio
   # graph packages
   - networkx
   # Code quality