Working with multiple data dictionary versions¶

import imas
from imas.util import get_data_dictionary_version

# 1. Create an IDSFactory
default_factory = imas.IDSFactory()

# 2. Print the DD version used by the IDSFactory
#
# This factory will use the default DD version, because we didn't explicitly indicate
# which version of the DD we want to use:
print("Default DD version:", default_factory.version)

# 3. Create an empty IDS
pf_active = default_factory.new("pf_active")
print("DD version used for pf_active:", get_data_dictionary_version(pf_active))
# What do you notice? This is the same version as the IDSFactory that was used to create
# it.

# 4. Create a new DBEntry
default_entry = imas.DBEntry(imas.ids_defs.MEMORY_BACKEND, "test", 0, 0)
default_entry.create()
# Alternative URI syntax when using AL5.0.0:
# default_entry = imas.DBEntry("imas:memory?path=.")
print("DD version used for the DBEntry:", get_data_dictionary_version(default_entry))
# What do you notice? It is the same default version again.

import imas
from imas.util import get_data_dictionary_version

# 1. Create an IDSFactory for DD 3.25.0
factory = imas.IDSFactory("3.25.0")

# 2. Create a pulse_schedule IDS
pulse_schedule = factory.new("pulse_schedule")
print(get_data_dictionary_version(pulse_schedule))  # This should print 3.25.0

# 3. Fill the IDS with some test data
pulse_schedule.ids_properties.homogeneous_time = \
    imas.ids_defs.IDS_TIME_MODE_HOMOGENEOUS
pulse_schedule.ids_properties.comment = \
    "Testing renamed IDS nodes with IMAS-Python"
pulse_schedule.time = [1., 1.1, 1.2]

pulse_schedule.ec.antenna.resize(1)
antenna = pulse_schedule.ec.antenna[0]
antenna.name = "ec.antenna[0].name in DD 3.25.0"
antenna.launching_angle_pol.reference_name = \
    "ec.antenna[0].launching_angle_pol.reference_name in DD 3.25.0"
antenna.launching_angle_pol.reference.data = [2.1, 2.2, 2.3]
antenna.launching_angle_tor.reference_name = \
    "ec.antenna[0].launching_angle_tor.reference_name in DD 3.25.0"
antenna.launching_angle_tor.reference.data = [3.1, 3.2, 3.3]

# 4. Convert the IDS from version 3.25.0 to 3.39.0
pulse_schedule_3_39 = imas.convert_ids(pulse_schedule, "3.39.0")

# Check that the data is converted
imas.util.print_tree(pulse_schedule_3_39)

# 5. Update time data
pulse_schedule.time[1] = 3
# Yes, the time array of the converted IDS is updated as well:
print(pulse_schedule_3_39.time)  # [1., 3., 1.2]

# 6. Update ids_properties/comment
pulse_schedule.ids_properties.comment = "Updated comment"
print(pulse_schedule_3_39.ids_properties.comment)
# What do you notice?
#   This prints the original value of the comment ("Testing renamed IDS
#   nodes with IMAS-Python").
# This is actually the same that you get when creating a shallow copy
# with ``copy.copy`` of a regular Python dictionary:
import copy

dict1 = {"a list": [1, 1.1, 1.2], "a string": "Some text"}
dict2 = copy.copy(dict1)
print(dict2)  # {"a list": [1, 1.1, 1.2], "a string": "Some text"}
# dict2 is a shallow copy, so dict1["a_list"] and dict2["a_list"] are
# the exact same object, and updating it is reflected in both dicts:
dict1["a list"][1] = 3
print(dict2)  # {"a list": [1, 3, 1.2], "a string": "Some text"}
# Replacing a value in one dict doesn't update the other:
dict1["a string"] = "Some different text"
print(dict2)  # {"a list": [1, 3, 1.2], "a string": "Some text"}

# 7. Set phase.reference_name:
pulse_schedule.ec.antenna[0].phase.reference_name = "Test refname"
# And convert again
pulse_schedule_3_39 = imas.convert_ids(pulse_schedule, "3.39.0")
imas.util.print_tree(pulse_schedule_3_39)
# What do you notice?
#   Element 'ec/antenna/phase' does not exist in the target IDS. Data is not copied.

import imas
import imas.training
from imas.util import get_data_dictionary_version

# 1. Load the training data for the ``core_profiles`` IDS
entry = imas.training.get_training_db_entry()
core_profiles = entry.get("core_profiles")

# 2. Print the DD version:
print(get_data_dictionary_version(core_profiles))

# 3. Create a new DBEntry with DD version 3.37.0
new_entry = imas.DBEntry(
    imas.ids_defs.MEMORY_BACKEND, "test", 0, 0, dd_version="3.37.0"
)
new_entry.create()

# 4. Put the core_profiles IDS in the new DBEntry
new_entry.put(core_profiles)

# 5. Print version_put.data_dictionary
print(core_profiles.ids_properties.version_put.data_dictionary)
# -> 3.37.0
# What do you notice?
#   The IDS was converted to the DD version of the DBEntry (3.37.0) when writing the
#   data to the backend.

import imas
from imas.ids_defs import ASCII_BACKEND, IDS_TIME_MODE_HOMOGENEOUS
from imas.util import get_data_dictionary_version

# 1. Create test data
# Create an IDSFactory for DD 3.25.0
factory = imas.IDSFactory("3.25.0")

# Create a pulse_schedule IDS
pulse_schedule = factory.new("pulse_schedule")

# Fill the IDS with some test data
pulse_schedule.ids_properties.homogeneous_time = IDS_TIME_MODE_HOMOGENEOUS
pulse_schedule.ids_properties.comment = "Testing renamed IDS nodes with IMAS-Python"
pulse_schedule.time = [1.0, 1.1, 1.2]

pulse_schedule.ec.antenna.resize(1)
antenna = pulse_schedule.ec.antenna[0]
antenna.name = "ec.antenna[0].name in DD 3.25.0"
antenna.launching_angle_pol.reference_name = (
    "ec.antenna[0].launching_angle_pol.reference_name in DD 3.25.0"
)
antenna.launching_angle_pol.reference.data = [2.1, 2.2, 2.3]
antenna.launching_angle_tor.reference_name = (
    "ec.antenna[0].launching_angle_tor.reference_name in DD 3.25.0"
)
antenna.launching_angle_tor.reference.data = [3.1, 3.2, 3.3]
antenna.phase.reference_name = "Phase reference name"

# And store the IDS in a DBEntry using DD 3.25.0
entry = imas.DBEntry(ASCII_BACKEND, "autoconvert", 1, 1, dd_version="3.25.0")
entry.create()
entry.put(pulse_schedule)
entry.close()

# 2. Reopen the DBEntry with DD 3.42.0:
entry = imas.DBEntry(ASCII_BACKEND, "autoconvert", 1, 1, dd_version="3.42.0")
entry.open()

# 3. Get the pulse schedule IDS
ps_autoconvert = entry.get("pulse_schedule")

print(f"{ps_autoconvert.ids_properties.version_put.data_dictionary=!s}")
print(f"{get_data_dictionary_version(ps_autoconvert)=!s}")
# What do you notice?
#   version_put: 3.25.0
#   get_data_dictionary_version: 3.40.0 -> the IDS was automatically converted

# 4. Print the data in the loaded IDS
imas.util.print_tree(ps_autoconvert)
# What do you notice?
#   1. The antenna AoS was renamed
#   2. Several nodes no longer exist!

print()
print("Disable autoconvert:")
print("====================")
# 5. Repeat steps 3 and 4 with autoconvert disabled:
ps_noconvert = entry.get("pulse_schedule", autoconvert=False)

print(f"{ps_noconvert.ids_properties.version_put.data_dictionary=!s}")
print(f"{get_data_dictionary_version(ps_noconvert)=!s}")
# What do you notice?
#   version_put: 3.25.0
#   get_data_dictionary_version: 3.25.0 -> the IDS was not converted!

# Print the data in the loaded IDS
imas.util.print_tree(ps_noconvert)
# What do you notice?
#   All data is here exactly as it was put at the beginnning of this exercise.