Add weldx file wrapper

CHANGELOG.md

@@ -7,6 +7,8 @@
 - added `asdf.util.get_schema_path` helper function [[#325]](https://github.com/BAMWelDX/weldx/pull/325)
 - added `util.compare_nested` to check equality of two nested data
   structures. [[#328]](https://github.com/BAMWelDX/weldx/pull/328)
+- added `WeldxFile` wrapper to handle asdf files with 
+  history and schemas more easily. [[#341]](https://github.com/BAMWelDX/weldx/pull/341).  
 
 ### changes
 

tutorials/GMAW_process.ipynb

@@ -32,10 +32,8 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "import asdf\n",
     "import weldx\n",
     "from weldx import Q_\n",
-    "from weldx.asdf.extension import WeldxAsdfExtension, WeldxExtension\n",
     "from weldx.core import TimeSeries as TS\n",
     "from weldx.welding.processes import GmawProcess"
    ]
@@ -130,7 +128,10 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "## using ASDF"
+    "## using ASDF\n",
+    "We write the dictionary containing our structured data to an ASDF file using the WeldxFile\n",
+    "class. We pass the tree as a named keyword argument.\n",
+    "The tree will be serialized to ASDF in memory, and we can have a look at the ASDF header."
    ]
   },
   {
@@ -145,20 +146,15 @@
   {
    "cell_type": "code",
    "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "buffer = weldx.asdf.util._write_buffer(tree)\n",
-    "weldx.asdf.util.notebook_fileprinter(buffer)"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
+   "metadata": {
+    "pycharm": {
+     "name": "#%%\n"
+    }
+   },
    "outputs": [],
    "source": [
-    "data = weldx.asdf.util._read_buffer(buffer)"
+    "file = weldx.WeldxFile(tree=tree)\n",
+    "file.show_asdf_header()"
    ]
   }
  ],

tutorials/custom_metadata.ipynb

@@ -69,7 +69,8 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "Now let's look at the ASDF file contents with our metadata:"
+    "Now let's look at the ASDF file contents with our metadata. We will find our data\n",
+    "at the very end after the ASDF header."
    ]
   },
   {
@@ -78,10 +79,9 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "from weldx.asdf.util import _write_buffer, notebook_fileprinter\n",
-    "\n",
-    "buffer = _write_buffer({\"sensor\": HKS_sensor})\n",
-    "notebook_fileprinter(buffer)"
+    "from weldx import WeldxFile\n",
+    "file = WeldxFile(tree={\"sensor\": HKS_sensor})\n",
+    "file.show_asdf_header()"
    ]
   },
   {
@@ -104,9 +104,8 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "from weldx.asdf.util import _read_buffer\n",
+    "data = WeldxFile(file.write_to())\n",
     "\n",
-    "data = _read_buffer(buffer)\n",
     "display(data[\"sensor\"].wx_metadata)\n",
     "display(data[\"sensor\"].wx_user)"
    ]

tutorials/measurement_example.ipynb

@@ -472,25 +472,20 @@
     "    # \"data_sources\": sources,\n",
     "    # \"data_processors\": processors,\n",
     "}\n",
-    "buffer = weldx.asdf.util._write_buffer(tree)"
+    "file = weldx.WeldxFile(tree=tree)"
    ]
   },
   {
    "cell_type": "code",
    "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "weldx.asdf.util.notebook_fileprinter(buffer)"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
+   "metadata": {
+    "pycharm": {
+     "name": "#%%\n"
+    }
+   },
    "outputs": [],
    "source": [
-    "data = weldx.asdf.util._read_buffer(buffer)"
+    "file.show_asdf_header()"
    ]
   }
  ],

tutorials/welding_example_01_basics.ipynb

@@ -556,7 +556,8 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "## using ASDF"
+    "## using ASDF\n",
+    "Now we write all of our structured data to an ASDF file and have a look at the ASDF header."
    ]
   },
   {
@@ -574,7 +575,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "buffer = weldx.asdf.util._write_buffer(tree)"
+    "file = weldx.WeldxFile(tree=tree)"
    ]
   },
   {
@@ -583,7 +584,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "weldx.asdf.util.notebook_fileprinter(buffer)"
+    "file.show_asdf_header()"
    ]
   }
  ],

weldx/__init__.py

@@ -22,6 +22,7 @@
 
 # asdf extensions and tags
 import weldx.asdf
+from weldx.asdf.file import WeldxFile
 
 # class imports to weldx namespace
 from weldx.constants import WELDX_QUANTITY as Q_
@@ -55,6 +56,7 @@
     "Shape",
     "SpatialData",
     "Trace",
+    "WeldxFile",
     "asdf",
     "core",
     "geometry",