imas-python 2.1.0.post1__py3-none-any.whl → 2.2.0__py3-none-any.whl

imas/__init__.py

@@ -1,30 +1,58 @@
 # This file is part of IMAS-Python.
 # You should have received the IMAS-Python LICENSE file with this project.
 
-# isort: skip_file
-
 from packaging.version import Version as _V
 
-from ._version import version as __version__  # noqa: F401
-from ._version import version_tuple  # noqa: F401
-
 # Import logging _first_
-from . import setup_logging
+# isort: off
+from . import setup_logging  # noqa: F401
+
+# isort: on
 
-# Import main user API objects in the imas module
+# Ensure that `imas.util` is loaded when importing imas
+from . import util  # noqa: F401
+
+# Public API:
+from ._version import version as __version__
+from ._version import version_tuple
+from .convert_core_edge_plasma import (
+    convert_to_plasma_profiles,
+    convert_to_plasma_sources,
+    convert_to_plasma_transport,
+)
 from .db_entry import DBEntry
-from .ids_factory import IDSFactory
 from .ids_convert import convert_ids
+from .ids_data_type import IDSDataType
+from .ids_factory import IDSFactory
 from .ids_identifiers import identifiers
-
-# Load the IMAS-Python IMAS AL/DD core
-from . import (
-    db_entry,
-    dd_zip,
-    util,
-)
+from .ids_metadata import IDSMetadata, IDSType
+from .ids_primitive import IDSPrimitive
+from .ids_struct_array import IDSStructArray
+from .ids_structure import IDSStructure
+from .ids_toplevel import IDSToplevel
 
 PUBLISHED_DOCUMENTATION_ROOT = "https://imas-python.readthedocs.io/en/latest/"
 """URL to the published documentation."""
 OLDEST_SUPPORTED_VERSION = _V("3.22.0")
 """Oldest Data Dictionary version that is supported by IMAS-Python."""
+
+__all__ = [
+    "__version__",
+    "version_tuple",
+    "DBEntry",
+    "IDSDataType",
+    "IDSFactory",
+    "IDSMetadata",
+    "IDSPrimitive",
+    "IDSStructure",
+    "IDSStructArray",
+    "IDSToplevel",
+    "IDSType",
+    "convert_ids",
+    "convert_to_plasma_profiles",
+    "convert_to_plasma_sources",
+    "convert_to_plasma_transport",
+    "identifiers",
+    "PUBLISHED_DOCUMENTATION_ROOT",
+    "OLDEST_SUPPORTED_VERSION",
+]

imas/_to_xarray.py

@@ -27,7 +27,7 @@ def to_xarray(ids: IDSToplevel, *paths: str) -> xarray.Dataset:
     # block checks if the paths are valid, and by using "metadata.path_string" we ensure
     # that / are used as separator.
     try:
-        paths = [ids.metadata[path].path_string for path in paths]
+        paths: list[str] = [ids.metadata[path].path_string for path in paths]
     except KeyError as exc:
         raise ValueError(str(exc)) from None
 

imas/_version.py

@@ -28,7 +28,7 @@ version_tuple: VERSION_TUPLE
 commit_id: COMMIT_ID
 __commit_id__: COMMIT_ID
 
-__version__ = version = '2.1.0.post1'
-__version_tuple__ = version_tuple = (2, 1, 0, 'post1')
+__version__ = version = '2.2.0'
+__version_tuple__ = version_tuple = (2, 2, 0)
 
 __commit_id__ = commit_id = None

imas/backends/db_entry_impl.py

@@ -78,7 +78,7 @@ class DBEntryImpl(ABC):
         destination: IDSToplevel,
         lazy: bool,
         nbc_map: Optional[NBCPathMap],
-    ) -> None:
+    ) -> IDSToplevel:
         """Implement DBEntry.get/get_slice/get_sample. Load data from the data source.
 
         Args:

imas/backends/imas_core/al_context.py

@@ -115,7 +115,7 @@ class ALContext:
         tmin: float,
         tmax: float,
         dtime: Optional[numpy.ndarray],
-        interpolation_method: int,
+        interpolation_method: Optional[int],
     ) -> "ALContext":
         """Begin a new timerange action for use in a ``with`` context."""
         ctx = ll_interface.begin_timerange_action(
@@ -163,7 +163,7 @@ class ALContext:
         """Call ual_write_data with this context."""
         status = ll_interface.write_data(self.ctx, path, timebasepath, data)
         if status != 0:
-            raise LowlevelError(f"write data at {path!r}: {status=}")
+            raise LowlevelError(f"write data at {path!r}", status)
 
     def list_all_occurrences(self, ids_name: str) -> List[int]:
         """List all occurrences of this IDS."""
@@ -359,7 +359,7 @@ class LazyALContext:
         tmin: float,
         tmax: float,
         dtime: Optional[numpy.ndarray],
-        interpolation_method: int,
+        interpolation_method: Optional[int],
     ) -> Iterator["LazyALContext"]:
         """Lazily start a lowlevel timerange action, see
         :meth:`ALContext.timerange_action`.

imas/backends/imas_core/db_entry_al.py

@@ -38,8 +38,8 @@ from imas.ids_toplevel import IDSToplevel
 
 from .al_context import ALContext, LazyALContext
 from .db_entry_helpers import delete_children, get_children, put_children
-from .imas_interface import LLInterfaceError, has_imas, ll_interface
-from .mdsplus_model import mdsplus_model_dir
+from .imas_interface import LLInterfaceError, ll_interface
+from .mdsplus_model import mdsplus_model_dir, get_mdsplus_model_var
 from .uda_support import extract_idsdef, get_dd_version_from_idsdef_xml
 
 _OPEN_MODES = {
@@ -52,14 +52,6 @@ _OPEN_MODES = {
 logger = logging.getLogger(__name__)
 
 
-def require_imas_available():
-    if not has_imas:
-        raise RuntimeError(
-            "The IMAS Core library is not available. Please install 'imas_core', "
-            "or load a supported IMAS module if you use an HPC environment."
-        )
-
-
 class ALDBEntryImpl(DBEntryImpl):
     """DBEntry implementation using imas_core as a backend."""
 
@@ -86,7 +78,6 @@ class ALDBEntryImpl(DBEntryImpl):
 
     @classmethod
     def from_uri(cls, uri: str, mode: str, factory: IDSFactory) -> "ALDBEntryImpl":
-        require_imas_available()
         if mode not in _OPEN_MODES:
             modes = list(_OPEN_MODES)
             raise ValueError(f"Unknown mode {mode!r}, was expecting any of {modes}")
@@ -105,9 +96,6 @@ class ALDBEntryImpl(DBEntryImpl):
         options: Any,
         factory: IDSFactory,
     ) -> "ALDBEntryImpl":
-        # Raise an error if imas is not available
-        require_imas_available()
-
         # Set defaults
         user_name = user_name or getpass.getuser()
         data_version = data_version or factory.dd_version
@@ -131,7 +119,7 @@ class ALDBEntryImpl(DBEntryImpl):
                 # Building the MDS+ models is required when creating a new Data Entry
                 ids_path = mdsplus_model_dir(factory)
                 if ids_path:
-                    os.environ["ids_path"] = ids_path
+                    os.environ[get_mdsplus_model_var()] = ids_path
 
         elif backend == "uda":
             # Set IDSDEF_PATH to point the UDA backend to the selected DD version
@@ -149,7 +137,7 @@ class ALDBEntryImpl(DBEntryImpl):
             if idsdef_path is None:
                 # Extract XML from the DD zip and point UDA to it
                 idsdef_path = extract_idsdef(factory.version)
-            os.environ["IDSDEF_PATH"] = idsdef_path
+            os.environ["IDSDEF_PATH"] = str(idsdef_path)
 
         elif backend in ["hdf5", "memory", "ascii", "flexbuffers"]:
             pass  # nothing to set up
@@ -184,7 +172,7 @@ class ALDBEntryImpl(DBEntryImpl):
         destination: IDSToplevel,
         lazy: bool,
         nbc_map: Optional[NBCPathMap],
-    ) -> None:
+    ) -> IDSToplevel:
         if self._db_ctx is None:
             raise RuntimeError("Database entry is not open.")
         if lazy and self.backend == "ascii":
@@ -268,6 +256,22 @@ class ALDBEntryImpl(DBEntryImpl):
             raise DataEntryException(
                 f"IDS {ids_name!r}, occurrence {occurrence} is empty."
             )
+
+        # UDA caching doesn't play well when the DD version of the on-disk IDS doesn't
+        # match the DD version of this DBEntry. See GH#97
+        if self.backend == "uda" and dd_version != self._ids_factory.dd_version:
+            cache_mode = self._querydict.get("cache_mode")
+            fetch = self._querydict.get("fetch")
+            if cache_mode != "none" and fetch not in ("1", "true"):
+                raise RuntimeError(
+                    f"The Data Dictionary version of the data ({dd_version}) is "
+                    "different from the Data Dictionary version of the DBEntry "
+                    f"({self._ids_factory.dd_version}). This is not supported when "
+                    f"using the UDA backend. See {imas.PUBLISHED_DOCUMENTATION_ROOT}"
+                    "multi-dd.html#uda-backend-caching-and-data-dictionary-versions "
+                    "for more details and workarounds."
+                )
+
         return dd_version
 
     def put(self, ids: IDSToplevel, occurrence: int, is_slice: bool) -> None:
@@ -299,7 +303,7 @@ class ALDBEntryImpl(DBEntryImpl):
         if occurrence != 0:
             ll_path += f"/{occurrence}"
 
-        time_mode = ids.ids_properties.homogeneous_time
+        time_mode = int(ids.ids_properties.homogeneous_time)
         if is_slice:
             with self._db_ctx.global_action(ll_path, READ_OP) as read_ctx:
                 db_time_mode = read_ctx.read_data(
@@ -344,9 +348,12 @@ class ALDBEntryImpl(DBEntryImpl):
             ll_path += f"/{occurrence}"
         ids = self._ids_factory.new(ids_name)
         with self._db_ctx.global_action(ll_path, WRITE_OP) as write_ctx:
-            delete_children(ids.metadata, write_ctx, "")
+            delete_children(ids.metadata, write_ctx)
 
     def list_all_occurrences(self, ids_name: str) -> List[int]:
+        if self._db_ctx is None:
+            raise RuntimeError("Database entry is not open.")
+
         try:
             occurrence_list = self._db_ctx.list_all_occurrences(ids_name)
         except LLInterfaceError:

imas/backends/imas_core/imas_interface.py

@@ -12,30 +12,17 @@ import logging
 
 from packaging.version import Version
 
-logger = logging.getLogger(__name__)
+# Import the Access Layer module
+# First try to import imas_core, which is available since AL 5.2
+from imas_core import _al_lowlevel as lowlevel
+from imas_core import imasdef  # noqa: F401
 
+logger = logging.getLogger(__name__)
 
-# Import the Access Layer module
-has_imas = True
-try:
-    # First try to import imas_core, which is available since AL 5.2
-    from imas_core import _al_lowlevel as lowlevel
-    from imas_core import imasdef
-
-    # Enable throwing exceptions from the _al_lowlevel interface
-    enable_exceptions = getattr(lowlevel, "imas_core_config_enable_exceptions", None)
-    if enable_exceptions:
-        enable_exceptions()
-
-except ImportError as exc:
-    imas = None
-    has_imas = False
-    imasdef = None
-    lowlevel = None
-    logger.warning(
-        "Could not import 'imas_core': %s. Some functionality is not available.",
-        exc,
-    )
+# Enable throwing exceptions from the _al_lowlevel interface
+enable_exceptions = getattr(lowlevel, "imas_core_config_enable_exceptions", None)
+if enable_exceptions:
+    enable_exceptions()
 
 
 class LLInterfaceError(RuntimeError):

imas/backends/imas_core/mdsplus_model.py

@@ -14,6 +14,7 @@ import uuid
 from pathlib import Path
 from subprocess import CalledProcessError, check_output
 from zlib import crc32
+from packaging.version import Version
 
 try:
     from importlib.resources import as_file, files
@@ -24,6 +25,8 @@ from imas.dd_zip import get_dd_xml, get_dd_xml_crc
 from imas.exception import MDSPlusModelError
 from imas.ids_factory import IDSFactory
 
+from .imas_interface import ll_interface
+
 logger = logging.getLogger(__name__)
 
 
@@ -292,6 +295,20 @@ def create_model_ids_xml(cache_dir_path, fname, version):
         raise e
 
 
+def get_mdsplus_model_var() -> str:
+    """
+    Return the environemnt variable name used by IMAS-Core to locate models:
+
+    - 'ids_path' for IMAS-Core<5.6
+    - 'MDSPLUS_MODELS_PATH' for IMAS-Core>=5.6
+    """
+    return (
+        "ids_path"
+        if ll_interface._al_version < Version("5.6.0")
+        else "MDSPLUS_MODELS_PATH"
+    )
+
+
 def create_mdsplus_model(cache_dir_path: Path) -> None:
     """Use jtraverser to compile a valid MDS model file."""
     try:
@@ -322,7 +339,7 @@ def create_mdsplus_model(cache_dir_path: Path) -> None:
             env={
                 "PATH": os.environ.get("PATH", ""),
                 "LD_LIBRARY_PATH": os.environ.get("LD_LIBRARY_PATH", ""),
-                "ids_path": str(cache_dir_path),
+                get_mdsplus_model_var(): str(cache_dir_path),
             },
         )
         # Touch a file to show that we have finished the model
@@ -349,7 +366,7 @@ def jTraverser_jar() -> Path:
     for component in os.environ.get("CLASSPATH", "").split(":"):
         if component.endswith(".jar"):
             if re.search(".*jTraverser.jar", component):
-                return component
+                return Path(component)
         else:  # assume its a directory (strip any '*' suffix)
             search_dirs.append(component.rstrip("*"))
 

imas/backends/imas_core/uda_support.py

@@ -1,6 +1,6 @@
 import logging
 from pathlib import Path
-from typing import Union
+from typing import Union, Optional
 from xml.etree import ElementTree as ET
 
 from imas import dd_zip
@@ -10,7 +10,7 @@ from .mdsplus_model import _get_xdg_cache_dir
 logger = logging.getLogger(__name__)
 
 
-def get_dd_version_from_idsdef_xml(path: Union[str, Path]) -> str:
+def get_dd_version_from_idsdef_xml(path: Union[str, Path]) -> Optional[str]:
     """Parse the IDSDef.xml up to the point where the Data Dictionary version is set.
 
     Returns:

imas/backends/netcdf/db_entry_nc.py

@@ -100,7 +100,7 @@ class NCDBEntryImpl(DBEntryImpl):
         destination: IDSToplevel,
         lazy: bool,
         nbc_map: Optional[NBCPathMap],
-    ) -> None:
+    ) -> IDSToplevel:
         # Feature compatibility checks
         if parameters is not None:
             if isinstance(parameters, GetSliceParameters):

imas/backends/netcdf/nc2ids.py

@@ -157,6 +157,8 @@ class NC2IDS:
                     for index, node in indexed_tree_iter(self.ids, target_metadata):
                         value = data[index]
                         if value != getattr(var, "_FillValue", None):
+                            if isinstance(value, np.generic):
+                                value = value.item()
                             # NOTE: bypassing IDSPrimitive.value.setter logic
                             node._IDSPrimitive__value = value
 
@@ -166,10 +168,16 @@ class NC2IDS:
                 # here, we'll let IDSPrimitive.value.setter take care of it:
                 self.ids[target_metadata.path].value = data
 
-            else:
+            # We need to unpack 0D ints, floats and complex numbers. For better
+            # performance this check is done outside the for-loop:
+            elif metadata.ndim or metadata.data_type is IDSDataType.STR:
                 for index, node in indexed_tree_iter(self.ids, target_metadata):
                     # NOTE: bypassing IDSPrimitive.value.setter logic
                     node._IDSPrimitive__value = data[index]
+            else:
+                for index, node in indexed_tree_iter(self.ids, target_metadata):
+                    # NOTE: bypassing IDSPrimitive.value.setter logic
+                    node._IDSPrimitive__value = data[index].item()  # Unpack 0D value
 
     def validate_variables(self) -> None:
         """Validate that all variables in the netCDF Group exist and match the DD."""
@@ -365,7 +373,7 @@ class LazyContext:
                 value = var[self.index]
 
             if value is not None:
-                if isinstance(value, np.ndarray):
+                if isinstance(value, (np.ndarray, np.generic)):
                     if value.ndim == 0:  # Unpack 0D numpy arrays:
                         value = value.item()
                     else:

imas/backends/netcdf/nc_metadata.py

@@ -1,7 +1,6 @@
 # This file is part of IMAS-Python.
 # You should have received the IMAS-Python LICENSE file with this project.
-"""NetCDF metadata for dimensions and tensorization of IDSs.
-"""
+"""NetCDF metadata for dimensions and tensorization of IDSs."""
 
 from functools import lru_cache
 from typing import Dict, List, Optional, Set, Tuple
@@ -89,7 +88,7 @@ class NCMetadata:
         # Add cache for public API
         self.get_dimensions = lru_cache(maxsize=None)(self.get_dimensions)
 
-    def get_coordinates(self, path: str, homogeneous_time: bool) -> Tuple[str]:
+    def get_coordinates(self, path: str, homogeneous_time: bool) -> Tuple[str, ...]:
         """Get the coordinates (adhering to CF conventions) for a netCDF variable.
 
         Args:
@@ -109,7 +108,7 @@ class NCMetadata:
             for coord in self.coordinates[path]
         )
 
-    def get_dimensions(self, path: str, homogeneous_time: bool) -> Tuple[str]:
+    def get_dimensions(self, path: str, homogeneous_time: bool) -> Tuple[str, ...]:
         """Get the dimensions for a netCDF variable.
 
         Args:

imas/command/cli.py

@@ -1,6 +1,6 @@
 # This file is part of IMAS-Python.
 # You should have received the IMAS-Python LICENSE file with this project.
-""" Main CLI entry point """
+"""Main CLI entry point"""
 
 import logging
 import sys
@@ -22,7 +22,13 @@ from rich.table import Table
 
 import imas
 import imas.backends.imas_core.imas_interface
-from imas import DBEntry, dd_zip
+from imas import (
+    DBEntry,
+    dd_zip,
+    convert_to_plasma_profiles,
+    convert_to_plasma_sources,
+    convert_to_plasma_transport,
+)
 from imas.backends.imas_core.imas_interface import ll_interface
 from imas.command.db_analysis import analyze_db, process_db_analysis
 from imas.command.helpers import min_version_guard, setup_rich_log_handler
@@ -109,6 +115,23 @@ def print_ids(uri, ids, occurrence, print_all):
         imas.util.print_tree(ids_obj, not print_all)
 
 
+def _check_convert_to_plasma_ids(idss_with_occurrences):
+    """Check if no plasma_ IDS is present when converting a core_ or edge_ IDS."""
+    idsnames = {ids_name for ids_name, _ in idss_with_occurrences}
+    for suffix in ("_profiles", "_sources", "_transport"):
+        if f"plasma{suffix}" in idsnames:
+            if f"core{suffix}" in idsnames:
+                overlap = "core"
+            elif f"edge{suffix}" in idsnames:
+                overlap = "edge"
+            else:
+                continue
+            raise RuntimeError(
+                f"Cannot convert {overlap}{suffix} IDS to plasma{suffix}: "
+                f"there already exists a plasma{suffix} IDS in the data source."
+            )
+
+
 @cli.command("convert", no_args_is_help=True)
 @click.argument("uri_in")
 @click.argument("dd_version")
@@ -127,8 +150,21 @@ If not provided, all IDSs in the data entry are converted.",
     is_flag=True,
     help="Don't add provenance metadata to the converted IDS.",
 )
+@click.option(
+    "--convert-to-plasma-ids",
+    is_flag=True,
+    help="Convert core/edge profiles/transport/sources to the corresponding plasma IDS",
+)
 def convert_ids(
-    uri_in, dd_version, uri_out, ids, occurrence, quiet, timeit, no_provenance
+    uri_in: str,
+    dd_version: str,
+    uri_out: str,
+    ids: str,
+    occurrence: int,
+    quiet: bool,
+    timeit: bool,
+    no_provenance: bool,
+    convert_to_plasma_ids: bool,
 ):
     """Convert a Data Entry (or a single IDS) to the target DD version.
 
@@ -174,6 +210,10 @@ def convert_ids(
             else:
                 idss_with_occurrences.append((ids_name, occurrence))
 
+        if convert_to_plasma_ids:  # Sanity checks for conversion to plasma IDSs
+            _check_convert_to_plasma_ids(idss_with_occurrences)
+            next_plasma_occurrence = {"_profiles": 0, "_transport": 0, "_sources": 0}
+
         # Create progress bar and task
         columns = (
             TimeElapsedColumn(),
@@ -209,6 +249,31 @@ def convert_ids(
                         provenance_origin_uri=provenance_origin_uri,
                     )
 
+            # Convert to plasma_profiles/plasma_sources/plasma_transport IDS
+            if convert_to_plasma_ids and ids_name.startswith(("core", "edge")):
+                suffix = ids_name[4:]
+                # This branch also matches core_instant_changes: check that suffix is ok
+                if suffix in next_plasma_occurrence:
+                    logger.info(
+                        "Storing IDS %s/%d as plasma%s/%d",
+                        ids_name,
+                        occurrence,
+                        suffix,
+                        next_plasma_occurrence[suffix],
+                    )
+                    occurrence = next_plasma_occurrence[suffix]
+                    next_plasma_occurrence[suffix] += 1
+
+                    name2 = f"[bold green]plasma{suffix}[/][green]/{occurrence}[/]"
+                    progress.update(task, description=f"Converting {name} to {name2}")
+                    if suffix == "_profiles":
+                        ids2 = convert_to_plasma_profiles(ids2)
+                    elif suffix == "_sources":
+                        ids2 = convert_to_plasma_sources(ids2)
+                    elif suffix == "_transport":
+                        ids2 = convert_to_plasma_transport(ids2)
+                    name = name2
+
             # Store in output entry:
             progress.update(task, description=f"Storing {name}", advance=1)
             with timer("Put", name):

imas/convert_core_edge_plasma.py

@@ -0,0 +1,124 @@
+# This file is part of IMAS-Python.
+# You should have received the IMAS-Python LICENSE file with this project.
+"""Logic to convert core/edge IDSs to their corresponding plasma ID."""
+
+from packaging.version import Version
+
+from imas.ids_toplevel import IDSToplevel
+from imas.ids_factory import IDSFactory
+from imas.exception import IDSNameError
+from imas.ids_convert import DDVersionMap, NBCPathMap, _copy_structure
+
+
+def convert_to_plasma_profiles(
+    core_or_edge_profiles: IDSToplevel, *, deepcopy: bool = False
+) -> IDSToplevel:
+    """Convert a core_profiles or edge_profiles IDS to a plasma_profiles IDS.
+
+    The input IDS must use a Data Dictionary version for which the plasma_profiles IDS
+    exists (3.42.0 or newer).
+
+    Args:
+        core_or_edge_profiles: The core_profiles or edge_profiles IDS to be converted.
+
+    Keyword Args:
+        deepcopy: When True, performs a deep copy of all data. When False (default),
+            numpy arrays are not copied and the converted IDS shares the same underlying
+            data buffers.
+    """
+    return _convert_to_plasma(core_or_edge_profiles, "profiles", deepcopy)
+
+
+def convert_to_plasma_sources(
+    core_or_edge_sources: IDSToplevel, *, deepcopy: bool = False
+) -> IDSToplevel:
+    """Convert a core_sources or edge_sources IDS to a plasma_sources IDS.
+
+    The input IDS must use a Data Dictionary version for which the plasma_sources IDS
+    exists (3.42.0 or newer).
+
+    Args:
+        core_or_edge_sources: The core_sources or edge_sources IDS to be converted.
+
+    Keyword Args:
+        deepcopy: When True, performs a deep copy of all data. When False (default),
+            numpy arrays are not copied and the converted IDS shares the same underlying
+            data buffers.
+    """
+    return _convert_to_plasma(core_or_edge_sources, "sources", deepcopy)
+
+
+def convert_to_plasma_transport(
+    core_or_edge_transport: IDSToplevel, *, deepcopy: bool = False
+) -> IDSToplevel:
+    """Convert a core_transport or edge_transport IDS to a plasma_transport IDS.
+
+    The input IDS must use a Data Dictionary version for which the plasma_transport IDS
+    exists (3.42.0 or newer).
+
+    Args:
+        core_or_edge_transport: The core_transport or edge_transport IDS to be
+            converted.
+
+    Keyword Args:
+        deepcopy: When True, performs a deep copy of all data. When False (default),
+            numpy arrays are not copied and the converted IDS shares the same underlying
+            data buffers.
+    """
+    return _convert_to_plasma(core_or_edge_transport, "transport", deepcopy)
+
+
+class _CoreEdgePlasmaMap(DDVersionMap):
+    """Subclass of DDVersionMap to generate an NBCPathMap that is suitable to copy
+    between a core/edge IDS and the corresponding plasma IDS."""
+
+    def __init__(self, source, target, factory):
+        self.ids_name = source
+        self.old_version = factory._etree
+        self.new_version = factory._etree
+        self.version_old = Version(factory.version)
+
+        self.old_to_new = NBCPathMap()
+        self.new_to_old = NBCPathMap()
+
+        old_ids_object = factory._etree.find(f"IDS[@name='{source}']")
+        new_ids_object = factory._etree.find(f"IDS[@name='{target}']")
+        self._build_map(old_ids_object, new_ids_object)
+
+
+def _convert_to_plasma(source: IDSToplevel, suffix: str, deepcopy: bool) -> IDSToplevel:
+    # Sanity checks for input data
+    if not isinstance(source, IDSToplevel):
+        raise TypeError(
+            f"First argument to convert_to_plasma_{suffix} must be a core_{suffix} or "
+            f"edge_{suffix} of type IDSToplevel. Got a type {type(source)} instead."
+        )
+    if source.metadata.name not in [f"core_{suffix}", f"edge_{suffix}"]:
+        raise ValueError(
+            f"First argument to convert_to_plasma_{suffix} must be a core_{suffix} or "
+            f"edge_{suffix} IDS. Got a {source.metadata.name} IDS instead."
+        )
+    if source._lazy:
+        raise NotImplementedError(
+            "IDS conversion is not implemented for lazy-loaded IDSs"
+        )
+
+    # Construct target plasma_{suffix} IDS
+    factory: IDSFactory = source._parent
+    try:
+        target = factory.new(f"plasma_{suffix}")
+    except IDSNameError:
+        raise ValueError(
+            f"Cannot convert {source.metadata.name} IDS to plasma_{suffix}: the source "
+            f"IDS uses Data Dictionary version {factory.dd_version} which doesn't have "
+            f"a plasma_{suffix} IDS. Please convert the source IDS to a supported Data "
+            "Dictionary version using `imas.convert_ids` and try again."
+        ) from None
+
+    # Leverage existing logic from ids_convert to do the copying
+    # First construct a map (to handle missing items in the target IDS)
+    data_map = _CoreEdgePlasmaMap(source.metadata.name, target.metadata.name, factory)
+    path_map = data_map.old_to_new  # old = core/edge, new = plasma IDS
+    _copy_structure(source, target, deepcopy, path_map)
+
+    return target