1. Introduction / Opening WelDX Files#
This tutorial is the first one of a whole series that has the purpose to teach you how to work with WelDX files using the
weldx Python package.
In each tutorial, we will focus on a small feature set and learn step by step how you can find, extract and process data stored in a WelDX file.
In this tutorial series, we will only focus on reading from already existing files.
How to write and modify a WelDX file will be covered in a follow up-series.
Note that we will only cover the most common features and not all possible tools the
weldx package provides.
For more in-depth information, read the dedicated API tutorials or have a look at the API documentation page.
1.2. Jupyter notebooks and online documentation#
All tutorials are written as jupyter notebooks so that you can always run and test the code on your local machine.
You can find them in the
tutorials subdirectory of our GitHub repository.
To learn how to install the
weldx package and all required dependencies to run the tutorials, visit the installation guide page of our online documentation.
All tutorials are also contained on the “Getting Started” page of the online documentation so that you can read a nicely rendered version online.
However, we strongly recommend to run and read the tutorials in a running jupyter-lab session.
Some features like interactive plots can only be displayed correctly by a jupyter server.
In case you don’t have the
weldx package or jupyter-lab installed yet but want to test the tutorial code, you can click on the binder link button that can be found at the top of each tutorial in the online version of the documentation.
This will start a virtual machine with everything set up correctly that you can access through your browser.
This concludes the first tutorial about opening and navigating through WelDX Files. You should now be able to read any given WelDX file and to inspect its structure. In the next tutorials, we will learn how to access the actual data and what we can do with it.