Refactor utility module

[vhirtham]

Changes

Separates xarray related utility functions from other utility functions and removes no longer needed functions.

Related Issues

Closes #480

Checks

• updated CHANGELOG.md
• updated tests
• updated doc/
• update example/tutorial notebooks

[pep8speaks]

Hello @vhirtham! Thanks for updating this PR.

• In the file weldx/asdf/util.py:

Line 1:5: E999 SyntaxError: invalid syntax

Comment last updated at 2021-08-23 07:31:33 UTC

[codecov]

Codecov Report

Merging #490 (498631d) into master (fe0f622) will decrease coverage by 0.02%.
The diff coverage is 98.19%.

@@            Coverage Diff             @@
##           master     #490      +/-   ##
==========================================
- Coverage   96.86%   96.84%   -0.03%     
==========================================
  Files          89       91       +2     
  Lines        5547     5543       -4     
==========================================
- Hits         5373     5368       -5     
- Misses        174      175       +1     

Impacted Files	Coverage Δ
weldx/asdf/file.py	97.43% <ø> (ø)
weldx/asdf/util.py	84.88% <ø> (ø)
weldx/geometry.py	99.44% <95.65%> (-0.13%)	⬇️
weldx/util/util.py	99.11% <99.11%> (ø)
weldx/util/__init__.py	100.00% <100.00%> (ø)
weldx/util/xarray.py	99.10% <100.00%> (ø)

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update fe0f622...498631d. Read the comment docs.

[vhirtham]

Looking at the remaining functions in the util module, I think it might make sense to mark it as private. Apart from some xarray functions, most of the stuff is not of any interest to the user. Even the xarray functions probably shouldn't be used outside of the package. What do you think @CagtayFabry @marscher

In case we want to keep it public, we need to discuss how the doc pages should look like. Currently, you get to an intermediate site that lists both submodules. I think this is okay this way to further categorize the functions and classes.

[CagtayFabry]

Looking at the remaining functions in the util module, I think it might make sense to mark it as private. Apart from some xarray functions, most of the stuff is not of any interest to the user. Even the xarray functions probably shouldn't be used outside of the package. What do you think @CagtayFabry @marscher

In case we want to keep it public, we need to discuss how the doc pages should look like. Currently, you get to an intermediate site that lists both submodules. I think this is okay this way to further categorize the functions and classes.

I actually like it the way it is now. 👍
Since the utility functions are in their own module now and don't clutter anything I like having them in the documentation :)
Especially for the xarray functions since they probably become much more handy when working more with spatial data or the new geometry stuff later. (we should probably flesh out the docstrings some more though)

[vhirtham]

Looking at the remaining functions in the util module, I think it might make sense to mark it as private. Apart from some xarray functions, most of the stuff is not of any interest to the user. Even the xarray functions probably shouldn't be used outside of the package. What do you think @CagtayFabry @marscher
In case we want to keep it public, we need to discuss how the doc pages should look like. Currently, you get to an intermediate site that lists both submodules. I think this is okay this way to further categorize the functions and classes.

I actually like it the way it is now. 👍
Since the utility functions are in their own module now and don't clutter anything I like having them in the documentation :)
Especially for the xarray functions since they probably become much more handy when working more with spatial data or the new geometry stuff later. (we should probably flesh out the docstrings some more though)

I think that all the functionality they provide should be wrapped by SpatialData and the corresponding geometry functions and classes. But we can leave them public for now and reevaluate later.