Skip to content

Retrieval Settings

A module for handling the options for retrieving data for a shot, passed in the retrieval_settings parameter of get_shots_data.

disruption_py.settings.retrieval_settings ¤

This module defines the RetrievalSettings class, which is used to configure settings for retrieving data for a single shot.

RetrievalSettings dataclass ¤

Settings for retrieving data for a single shot.

ATTRIBUTE DESCRIPTION
efit_nickname_setting

Nickname setting for retrieving efit tree data (default is "disruption").

TYPE: (NicknameSetting, optional)

run_methods

List of physics methods to run (default is None). If None, and run_columns is None, all methods will be run. Named methods will be run when retrieving data from MDSplus for the shot. Named methods must have the physics_method decorator and either be passed in the custom_physics_methods argument or included in the built-in method holders.

TYPE: list of str, optional

run_columns

List of columns to retrieve (default is None). If None, and run_methods is None, all methods will be run. If specified, all methods with the physics_method decorator referencing the specified column will be run and all columns returned by those methods will be used. If you wish to only return the requested columns, set only_requested_columns to True in the retrieval_settings.

TYPE: list of str, optional

only_requested_columns

Whether to only include requested columns in the result (default is False).

TYPE: (bool, optional)

custom_physics_methods

List of custom physics methods (default is an empty list). The Methods are collected and run when retrieving data from MDSplus if the method is included through either the run_methods or run_columns setting.

TYPE: (list, optional)

time_setting

Time setting for the shot (default is "disruption_warning"). The retrieved data will be interpolated to this timebase. Can pass any TimeSettingType that resolves to a TimeSetting. See TimeSetting for more details.

TYPE: (TimeSetting, optional)

domain_setting

Domain setting for the timebase (default is "full"). Either "full", "flattop", or "rampup_and_flattop". Can pass any DomainSettingType that resolves to a DomainSetting such as the listed strings.

TYPE: (DomainSetting, optional)

Source code in disruption_py/settings/retrieval_settings.py 
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
@dataclass
class RetrievalSettings:
    """
    Settings for retrieving data for a single shot.

    Attributes
    ----------
    efit_nickname_setting : NicknameSetting, optional
        Nickname setting for retrieving efit tree data (default is "disruption").
    run_methods : list of str, optional
        List of physics methods to run (default is None). If None, and run_columns
        is None, all methods will be run. Named methods will be run when retrieving
        data from  MDSplus for the shot. Named methods must have the physics_method
        decorator and either be passed in the `custom_physics_methods` argument
        or included in the built-in method holders.
    run_columns : list of str, optional
        List of columns to retrieve (default is None). If None, and run_methods is
        None, all methods will be run. If specified, all methods with the physics_method
        decorator referencing the specified column will be run and all columns returned
        by those methods will be used. If you wish to only return the requested columns,
        set only_requested_columns to True in the retrieval_settings.
    only_requested_columns : bool, optional
        Whether to only include requested columns in the result (default is False).
    custom_physics_methods : list, optional
        List of custom physics methods (default is an empty list). The Methods are
        collected and run when retrieving data from MDSplus if the method is included
        through either the run_methods or run_columns setting.
    time_setting : TimeSetting, optional
        Time setting for the shot (default is "disruption_warning"). The retrieved
        data will be interpolated to this timebase. Can pass any `TimeSettingType`
        that resolves to a TimeSetting. See TimeSetting for more details.
    domain_setting : DomainSetting, optional
        Domain setting for the timebase (default is "full"). Either "full", "flattop",
        or "rampup_and_flattop". Can pass any `DomainSettingType` that resolves
        to a `DomainSetting` such as the listed strings.
    """

    # Shot creation settings
    efit_nickname_setting: NicknameSetting = "disruption"

    # Shot run settings
    run_methods: List[str] | None = None
    run_columns: List[str] | None = None
    only_requested_columns: bool = False
    custom_physics_methods: list = field(default_factory=list)

    # Timebase setting
    time_setting: TimeSetting = "disruption_warning"
    domain_setting: DomainSetting = "full"

    def __post_init__(self):
        """Resolve settings after initialization."""
        self.resolve()

    def resolve(self):
        """
        Resolve preset values into specific objects or enums.

        This method resolves passed strings, lists, and dictionaries into specific
        request types or enums.
        """

        self.time_setting = resolve_time_setting(self.time_setting)
        self.domain_setting = resolve_domain_setting(self.domain_setting)
        self.efit_nickname_setting = resolve_nickname_setting(
            self.efit_nickname_setting
        )

        if self.run_columns is not None:
            self.run_columns = [col.lower() for col in self.run_columns]
__post_init__ ¤
__post_init__()

Resolve settings after initialization.

Source code in disruption_py/settings/retrieval_settings.py 
69
70
71
def __post_init__(self):
    """Resolve settings after initialization."""
    self.resolve()