High Level Interfaces and their API (Application Programming Interface)
The IMAS Data Access Layer exposes a couple of operations (so-called API) for writing or reading IDSs data.
These data access operations are available from users code in the currently supported programming languages, the so-called There are currently 5 High Level Interfaces (HLIs) available from the following programming languagesHLI):
- Fortran
- C++
- Java
- Python
- Matlab
| Info |
|---|
| Only Python and Matlab provide user interactive session for accessing IMAS data. |
The HLI API covers all available Access Layer features:
- creating a so-called new IMAS Data Entry
- opening an existing IMAS Data Entry
- writing data from an IDS to a Data Entry
- reading data of an IDS from an existing Data Entry
- deleting an IDS from an existing Data Entry
- closing a Data Entry
can be divided in 2 sets of operations:
- operations applying on a Data Entry
- operations applying on an IDS
| Info |
|---|
| A Data Entry is an IMAS concept for designating a |
...
| collection of IDSs present in a local (pulse file) or remote data source. A data entry is associated to a shot and a run number. |
The HLI API covers all available Access Layer features consisting in:
- creating a new Data Entry
- opening an existing Data Entry
- writing data from an IDS to a Data Entry
- reading data of an IDS from an existing Data Entry
- deleting an IDS from an existing Data Entry
- closing a Data Entry
The HLI API covers all available Access Layer features with the following exposed methods:
- Operations on a data base entry:
- CREATE (creation of a new Data Entry)
- OPEN (opening an existing Data Entry)
- CLOSE (closing a Data Entry)
- Operations on IDSs:
- PUT (writing data from an IDS to a Data Entry)
- GET (reading data of an IDS from an existing Data Entry)
- PUT_SLICE (writing a IDS time slice to a Data Entry)
- GET_SLICE (reading a time slice of an IDS from an existing Data Entry)
- DELETE (deleting an IDS from an existing Data Entry)
The methods exposed by HLIs are:
- Operations on data base entry:
- CREATE
- OPEN
- CLOSE
- Operations on IDSs:
- PUT
- GET
- PUT_SLICE
- GET_SLICE
- DELETE
In this tutorial, we will describe each method of the HLI API (section 1.1. HLI API).
...