Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Weldxfile tutorial + minor fixes #355

Merged
merged 18 commits into from May 17, 2021
Merged

Conversation

marscher
Copy link
Collaborator

@marscher marscher commented May 11, 2021

Changes

Added a tutorial describing the basic usage of the previously introduced WeldxFile class.

Fixes

  • ASDF-2.8 removed the util function is_asdf_file, wrote a workaround.
  • properly close file underlying handles, e.g. when opening a path via open.
  • doctest in welding_schema
  • get_schema_path uses constant SCHEMA_PATH

Checks

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

@review-notebook-app
Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@marscher marscher added ASDF everything ASDF related (python + schemas) documentation Improvements or additions to documentation labels May 11, 2021
@marscher marscher changed the title Weldxfile tut Weldxfile tutorial + minor fixes May 12, 2021
@codecov
Copy link

codecov bot commented May 12, 2021

Codecov Report

Merging #355 (69feb83) into master (63c93ee) will increase coverage by 0.03%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master     #355      +/-   ##
==========================================
+ Coverage   96.87%   96.91%   +0.03%     
==========================================
  Files          87       87              
  Lines        5214     5214              
==========================================
+ Hits         5051     5053       +2     
+ Misses        163      161       -2     
Impacted Files Coverage Δ
weldx/asdf/file.py 96.61% <0.00%> (+1.12%) ⬆️

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 63c93ee...69feb83. Read the comment docs.

@marscher marscher marked this pull request as ready for review May 12, 2021 12:49
@marscher
Copy link
Collaborator Author

Seems like the update to Sphinx-4.0 on RTD makes the build failing.

@marscher
Copy link
Collaborator Author

reported import errors in sphinx upstream. Cref sphinx-doc/sphinx#9243

@marscher marscher requested a review from CagtayFabry May 17, 2021 08:29
@marscher
Copy link
Collaborator Author

@CagtayFabry sorry for disturbing your writing silence. This is a blocker for ASDF-2.8 and I'd like to merge it quickly. I double checked the new tutorial and we can sort out problems with this later on. Or do you want me to open a separate PR just for the ASDF related fix(es)?

@CagtayFabry
Copy link
Member

@CagtayFabry sorry for disturbing your writing silence. This is a blocker for ASDF-2.8 and I'd like to merge it quickly. I double checked the new tutorial and we can sort out problems with this later on. Or do you want me to open a separate PR just for the ASDF related fix(es)?

seems like I missed the 2.8 release
The changes needed for ASDF 2.8 are collected here #218 (probably a little outdated)
I guess we should update and merge quickly, maybe a minor weldx release just for ASDF 2.8 support as well
what do you think about merging this into #218 and updating that PR to fully support 2.8?

I will look into it #218 and this later tonight

@marscher
Copy link
Collaborator Author

marscher commented May 17, 2021 via email

@marscher marscher merged commit 6fe2559 into BAMWelDX:master May 17, 2021
@marscher marscher deleted the weldxfile_tut branch May 17, 2021 12:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ASDF everything ASDF related (python + schemas) documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants