You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/source/tendencies.rst
-44Lines changed: 0 additions & 44 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,8 +8,6 @@ This document describes the different types of tendencies available in the Wavef
8
8
9
9
Each tendency defines the behavior of the signal over a specific time interval. You can chain multiple tendencies together to create complex waveforms.
10
10
11
-
If ``type`` is omitted it is inferred from the entry's keys: ``ref`` → :ref:`import <import-tendency>`, ``to`` → linear, ``time`` → :ref:`piecewise <piecewise-linear-tendency>`, ``value`` → constant; anything else defaults to ``linear`` (so a ``from``-only, ``rate``-only, or bare segment is still a linear ramp). Tendencies with no distinguishing key -- the periodic shapes, ``smooth``, and a value-less ``constant`` -- must name their ``type`` explicitly.
12
-
13
11
Common Time Parameters
14
12
======================
15
13
@@ -190,48 +188,6 @@ Parameters
190
188
.. warning::
191
189
This tendency does **not** accept the common ``start``, ``duration``, or ``end`` parameters. These are derived directly from the required ``time`` list.
192
190
193
-
.. _import-tendency:
194
-
195
-
Import
196
-
======
197
-
198
-
Takes its values from an external entry in :ref:`globals.imports <global_properties>` instead of an analytic shape, resampled onto the export time base. By default it reads the waveform's own DD path.
199
-
200
-
*Type:* ``import`` (inferred when ``ref`` is present)
201
-
202
-
Parameters
203
-
----------
204
-
* ``ref``: Entry in ``globals.imports`` to read from.
205
-
* ``path``: DD path to read. Defaults to the waveform's own path.
206
-
* ``time_offset``: Offset added to the export time when sampling. Defaults to ``0``.
207
-
* ``interp``: Resampling mode: ``closest`` (default), ``linear`` or ``previous``.
Wildcards expand against the source: a trailing ``*`` imports a whole subtree (``<ids>/*`` copies a whole IDS), and a ``(*)`` index wildcard iterates every element of an array of structure -- several may be combined, e.g. every ion of every source. An overlay may list several sources, applied in order:
**Precedence.** Where imports or explicit waveforms write the same node, the most specific wins regardless of order: ``<ids>/*`` < subtree ``.../*`` < explicit leaf. Equal specificity falls back to listing order (last wins).
226
-
227
-
Non-0D imports (a profile, a wildcard subtree) own the whole waveform. Only **0D (scalar)** imports combine with analytic segments, each filling its ``[start, end]`` window:
228
-
229
-
.. code-block:: yaml
230
-
231
-
equilibrium/time_slice/global_quantities/ip:
232
-
- {type: constant, value: -1.0, duration: 1} # analytic on [0, 1] s
233
-
- {ref: scenario, duration: 1} # imported on [1, 2] s
Copy file name to clipboardExpand all lines: docs/source/yaml_format.rst
+10-28Lines changed: 10 additions & 28 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -50,29 +50,21 @@ These parameters can be changed under the "Edit Global Properties" tab in the GU
50
50
globals:
51
51
dd_version: 3.42.0
52
52
53
-
* **imports:** Named external data entries that waveforms read from (see
54
-
:ref:`Import <import-tendency>`), keyed by names you choose and refer to with
55
-
``{ref: <name>}``. Each value is an IMAS URI, or ``{port: <name>}`` for an IDS
56
-
received on a MUSCLE3 port at run time (used by the actor).
53
+
* **machine_description:** Provides URIs for IMAS machine description entries.
54
+
The machine descriptions are relevant when you :ref:`export a waveform configuration to an IDS<export-ids>`.
55
+
When exporting, any existing data from the given machine description will be copied
56
+
to the new IDS, before the waveforms from the configuration are added.
57
+
To specify machine descriptions for a target IDS, use a dictionary where keys are
58
+
the IDS names and values are their corresponding machine description URIs.
57
59
58
60
.. code-block:: yaml
59
61
60
62
globals:
61
63
dd_version: 3.42.0
62
-
imports:
63
-
machine: imas:hdf5?path=machine_description1
64
-
scenario: imas:hdf5?path=scenario_run
65
-
live_eq: {port: equilibrium_in}
66
-
67
-
Overlay a machine-description IDS with an ``<ids>/*`` wildcard import, then override
68
-
individual nodes.
69
-
70
-
.. code-block:: yaml
71
-
72
-
ec_launchers:
73
-
ec_launchers/*:
74
-
- {ref: machine} # overlay base
75
-
ec_launchers/beam(1)/phase/angle: -1.65898# then override leaves
64
+
machine_description:
65
+
ec_launchers: imas:hdf5?path=machine_description1
66
+
nbi: imas:hdf5?path=machine_description2
67
+
# Add other IDSs as needed
76
68
77
69
Grouping Waveforms
78
70
------------------
@@ -114,8 +106,6 @@ a list of waveforms, or a single number (float or integer).
114
106
# Implicit linear ramp back to 0 over 25 seconds
115
107
- { duration: 25, to: 0 }
116
108
117
-
If ``type`` is omitted it is inferred from the entry's keys: ``ref`` → ``import``, ``to`` → ``linear``, ``time`` → ``piecewise``, ``value`` → ``constant``; anything else defaults to ``linear``. Tendencies with no distinguishing key (the periodic shapes, ``smooth``, a value-less ``constant``) must name their ``type``.
118
-
119
109
Refer to the :ref:`Available Tendencies <available-tendencies>` documentation for details on the different tendency types and their parameters.
120
110
121
111
2. **Constant Value:** A simple number (integer or float) defines a constant waveform over time.
@@ -164,12 +154,4 @@ Slicing can be applied at multiple nested levels. For example, the following fil
The following configuration exercises the full :ref:`imports <import-tendency>` mechanism: a machine-description overlay (``<ids>/*``), a scalar import with interpolation, a static value, trailing-subtree and index wildcards (``source(*)``, ``ion(*)``), a 0D composite, and a runtime port-import.
0 commit comments