Skip to content

Commit ef5cf09

Browse files
committed
Add documentation for input profiles loading
1 parent 2a47db7 commit ef5cf09

1 file changed

Lines changed: 12 additions & 0 deletions

File tree

docs/configuration.rst

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1779,6 +1779,18 @@ There are three main methods to load IMAS equilibrium:
17791779
* Providing the equilibium IDS on the fly (equilibrium_object).
17801780
Using this method the IDS can be provided externally or pre-loaded.
17811781
1782+
Loading Profiles
1783+
^^^^^^^^^^^^^^^^
1784+
1785+
The initial and optionnally prescribed time-dependence of the temperature, density and current profiles given in the config can be loaded from any IMAS core_profiles or plasma_profiles IDS.
1786+
The IDSs needs to be in Data Dictionary version 4.0.0 or newer.
1787+
The mapping function :todo:`add the actual link to the function` |core_profiles_from_imas| returns a dictionary with the data from core_profiles to load into the config. The IDS needs to be provided on the fly as it can be done for the geometry.
1788+
The IDS object can be loaded from an IMAS netCDF file using the `IMAS-Python library <https://imas-python.readthedocs.io/en/latest/netcdf.html>`_ .
1789+
1790+
It is then possible to start a simulation using the IMAS profiles by loading a pre-existing config and then update it with this dictionary using the function :todo:`same: add the link to the help function` |update_dict|.
1791+
1792+
1793+
17821794
Config example
17831795
==============
17841796

0 commit comments

Comments
 (0)