Asdf-Support

ndcube/asdf/converters/ndcube_converter.py

@@ -0,0 +1,30 @@
+from asdf.extension import Converter
+import numpy as np
+
+
+class NDCubeConverter(Converter):
+    tags = ["tag:sunpy.org:ndcube/ndcube/NDCube-*"]
+
+    @property
+    def types(self):
+        from ndcube.ndcube import NDCube
+        return [NDCube]
+
+    def select_tag(self, obj, tags, ctx):
+        # Sort the tags in reverse alphabetical order and pick the first (i.e.
+        # the one with the highest version). This assumes that all the tags for
+        # this converter are named the same other than the version number.
+        tags = list(sorted(tags, reverse=True))
+        return tags[0]
+
+    def from_yaml_tree(self, node, tag, ctx):
+        from ndcube import ndcube
+        data = np.asanyarray(node["data"])
+        wcs = node["wcs"]
+        return(ndcube.NDCube(data, wcs))
+
+    def to_yaml_tree(self, ndcube, tag, ctx):
+        node = {}
+        node["data"] = np.asarray(ndcube.data)
+        node["wcs"] = ndcube.wcs
+        return node

ndcube/asdf/entry_points.py

@@ -0,0 +1,40 @@
+"""
+This file contains the entry points for asdf.
+"""
+import importlib.resources as importlib_resources
+from asdf.extension import ManifestExtension
+from asdf.resource import DirectoryResourceMapping
+
+
+def get_resource_mappings():
+    """
+    Get the resource mapping instances for myschemas
+    and manifests.  This method is registered with the
+    asdf.resource_mappings entry point.
+
+    Returns
+    -------
+    list of collections.abc.Mapping
+    """
+    from ndcube.asdf import resources
+    resources_root = importlib_resources.files(resources)
+    return [
+        DirectoryResourceMapping(
+            resources_root / "schemas", "asdf://sunpy.org/ndcube/schemas/"),
+        DirectoryResourceMapping(
+            resources_root / "manifests", "asdf://sunpy.org/ndcube/manifests/"),
+    ]
+
+
+def get_extensions():
+    """
+    Get the list of extensions.
+    """
+    from ndcube.asdf.converters.ndcube_converter import NDCubeConverter
+
+    ndcube_converters = [NDCubeConverter()]
+    _manifest_uri = "asdf://sunpy.org/ndcube/manifests/ndcube-0.1.0"
+
+    return [
+        ManifestExtension.from_uri(_manifest_uri, converters=ndcube_converters)
+    ]

ndcube/asdf/resources/manifests/ndcube-0.1.0.yaml

@@ -0,0 +1,10 @@
+%YAML 1.1
+---
+id: asdf://sunpy.org/ndcube/manifests/ndcube-0.1.0
+extension_uri: asdf://sunpy.org/extensions/ndcube-0.1.0
+title: NDCube ASDF Manifest
+description: ASDF schemas and tags for NDCube classes.
+
+tags:
+  - tag_uri: "tag:sunpy.org:ndcube/ndcube/NDCube-0.1.0"
+    schema_uri: "asdf://sunpy.org/ndcube/schemas/NDCube-0.1.0"

ndcube/asdf/resources/schemas/NDCube-0.1.0.yaml

@@ -0,0 +1,21 @@
+%YAML 1.1
+---
+$schema: "http://stsci.edu/schemas/yaml-schema/draft-01"
+id: "asdf://sunpy.org/ndcube/schemas/NDCube-0.1.0"
+
+title: |
+  Represents the ndcube NDCube object
+
+description:
+  Represents the ndcube NDCube object
+
+type: object
+properties:
+  data:
+    tag: "tag:stsci.edu:asdf/core/ndarray-1.0.0"
+  wcs:
+    $ref: "http://stsci.edu/schemas/gwcs/wcs-1.1.0"
+
+required: [data , wcs]
+allowAdditionalProperties: False
+...

pyproject.toml

@@ -71,6 +71,12 @@ exclude = ["ndcube._dev*"]
 [tool.setuptools_scm]
 write_to = "ndcube/_version.py"
 
+[project.entry-points."asdf.resource_mappings"]
+ndcube = "ndcube.asdf.entry_points:get_resource_mappings"
+
+[project.entry-points."asdf.extensions"]
+ndcube = "ndcube.asdf.entry_points:get_extensions"
+
 [tool.towncrier]
     package = "ndcube"
     filename = "CHANGELOG.rst"