You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 24 Next »

1.1. Fortran

  • bindings to lowlevel C/C++ is done explicitly through iso_c_bindings, without reallocating arrays when possible (for all non-character based quantities)

    Because of arrays being allocated in C when IDS is obtained from AL (get/get_slice), deallocation / allocation should be done with extra care especially for routines using IDS as inout arguments! A new substructure level deallocation routine was introduced (see table below) but it needs additional logical input specifying if arrays of the substructure were allocated in C (AL) or Fortran (user's code). Two options:
    a) the IDS is deallocate within the user's code scope, then a mix of C/F allocation need to be deallocated accordingly
    b) the IDS is potentially used/extended/deallocated by another code, or is coming from different contexts (AL or another Fortran code), then the safer approach is to work on a copy of the IDS (potentially only for inout IDS which are coming from AL, which can be checked using the new is_c_data routine presented in table below)
  • wrappers around lowlevel API are provided, allowing for instance to select a different backend

 

OperationAL3AL4Remarks

creating a data-entry

(MDSplus backend)

call imas_create(name,shot,run,shotref,runref,idx)
call imas_create_env(name,shot,run,shotref,runref,& 
                     idx,user,machine,version)

 

 

call imas_create_env(name,shot,run,shotref,runref,&
                     idx,user,machine,version)

Concept of default machine is deprecated

Arguments name,refshot,refrun can have any (or empty) value, and are kept only for compatibility. A new unique data-entry selection routine will be added to the API, making this routine deprecated at term.

opening a data-entry

(MDSplus backend)

call imas_open(name,shot,run,idx)
call imas_open_env(name,shot,run,idx,&
                   user,machine,version)
 
call imas_open_env(name,shot,run,idx,&
                   user,machine,version)

Concept of default machine is deprecated

Argument name can have any (or empty) value, and is kept only for compatibility. A new unique data-entry selection routine will be added to the API, making this routine deprecated at term.

writing the complete IDS
call ids_put(idx,idsname,ids)
call ids_put(idx,idsname,ids)
 
writing a single slice of an IDS
call ids_put_slice(idx,idsname,ids)
call ids_put_slice(idx,idsname,ids)
 
writing only non-timed data of an IDS
call ids_put_non_timed(idx,idsname,ids)
 Deprecated, replaced by ids_put() on IDS containing only first slice data
reading the complete IDS
call ids_get(idx,idsname,ids)
call ids_get(idx,idsname,ids)
 
reading a single slice of an IDS
call ids_get_slice(idx,idsname,ids,time,interpol)
call ids_get_slice(idx,idsname,ids,time,interpol)
Paremeters are defined in ual_defs module for the different interpolation modes (to be used for interpol argument): CLOSEST_INTERP,PREVIOUS_INTERP,LINEAR_INTERP
copying an IDS or one of its substructure
call ids_copy(src,dest)
call ids_copy(src,dest)

 

 

 

deallocating an IDS or one if its substructure
call ids_deallocate(ids)
call ids_deallocate(ids)
call ids_deallocate_struct(struct,c_data)
When deallocating a substructure of an IDS, one need to pass a logical argument indicating whether this structure has been obtained allocated in C (obtained from AL get(),get_slice()) or not. This check is performed automatically while deallocating an entire IDS
checking if arrays of an IDS were allocated in C (by AL) 
call is_c_data(ids,c_data)
Returns the c_data logical which is .true. if the IDS was obtained through the Access Layer, .false. otherwise.
deleting an IDS from a data-entry
call ids_delete(idx,idsname,ids)
call ids_delete(idx,idsname,ids)
 

closing a data-entry

call imas_close(idx)
call imas_close(idx)
 

 

 

 

1.2. C++

 

OperationAL3AL4Remarks

creating a data-entry

(MDSplus backend)

IdsNs::IDS imas_entry(pulse,run,0,0);

imas_entry.create();

OR

IdsNs::IDS ids(pulse,run,0,0);

ids.createEnv(UserName, DatabaseName, IMASVersion);

IdsNs::IDS imas_entry(pulse,run,0,0)

imas_entry.createEnv(UserName, DatabaseName, IMASVersion);

 

 

opening a data-entry

(MDSplus backend)

IdsNs::IDS imas_entry(pulse,run,0,0);

imas_entry.open();

OR

IdsNs::IDS imas_entry(pulse,run,0,0);

imas_entry.openEnv(UserName, DatabaseName, IMASMajorVersion);

IdsNs::IDS imas_entry(pulse,run,0,0);
imas_entry.openEnv(‘usr’, ‘test’, ‘3’);

 

 

writing the complete IDSimas_entry._<ids_name>.put(); for occurrence 0

imas_entry._<ids_name>.put(n); for occurrence n

Method of the ids object: def put(self, occurrence=0)

Example:

IdsNs::IDS imas_entry(12,1,0,0);

imas_entry._<ids_name>.ids_properties.comment_of = "Test data";

imas_entry._<ids_name>.put(); for occurrence 0

imas_entry._<ids_name>.put(n); for occurrence n
 
writing a single slice of an IDS

Method of the ids object: def putSlice(self,

occurrence=0)

Example:

IdsNs::IDS imas_entry(12,1,0,0);

imas_entry._actuator.putSlice();for occurrence 0

imas_entry._actuator.putSlice(n); for occurrence n

Method of the ids object: def putSlice(self, occurrence=0)

Example:

IdsNs::IDS imas_entry(12,1,0,0);

imas_entry._<ids_name>.putSlice();for occurrence 0

imas_entry._<ids_name>.putSlice(n); for occurrence n

 
writing only non-timed data of an IDS

 

imas_entry._<ids_name>.putNonTimed(); for

occurrence 0

imas_entry._<ids_name>.putNonTimed(n); for

occurrence n

Deprecated 
reading the complete IDS

imas_entry._<ids_name>.get(); for occurrence 0

imas_entry._<ids_name>.get(n); for occurrence n

imas_entry._<ids_name>.get(); for occurrence 0

imas_entry._<ids_name>.get(n); for occurrence n

 
reading a single slice of an IDS
for occurrence 0
  imas_entry._<ids_name>.getSlice(time_requested, interpolation_method); 
for occurrence n
  imas_entry._<ids_name>.getSlice(n, time_requested, interpolation_method);
 
for occurrence 0:
  imas_entry._<ids_name>.getSlice(time_requested, interpolation_method);
for occurrence n:
  imas_entry._<ids_name>.getSlice(n, time_requested, interpolation_method); 
 
CLOSEST_SAMPLE PREVIOUS_SAMPLE INTERPOLATION
copying an IDS or one of its substructure
 
 
 
flushing all IDSes from the cache to the disk

imas_entry.flushAll();

Deprecated

 
discarding all IDSes

imas_entry.discardAll();

Deprecated

 
deallocating an IDS or one if its substructure
 
  
checking if arrays of an IDS were allocated in C (by AL) 
 
 
deleting an IDS from a data-entry
imas_entry._<ids_name>.remove();
imas_entry._<ids_name>.remove();
 

closing a data-entry

imas_entry.close();

imas_entry.close();
 

 

 

 

1.3. Python

 

OperationAL3AL4Remarks

creating a data-entry

(MDSplus backend)

A sequence of calls imas.ids(pulse, run) and

create() on newly created object

e.g.

import imas

ids_object = imas.ids(12,1)

ids_object.create()

sequence of calls imas.ids(pulse, run) and

e.g.

import imas

ids_object = imas.ids(12,1)

ids_object.create_env(‘usr’, ‘test’, ‘3’)

sequence of calls imas.ids(pulse, run) and

e.g.

import imas 

ids_object = imas.ids(12,1)

ids_object.create_env(‘usr’, ‘test’, ‘3’) idx = imas_create_env( treename, pulse, run, 0, 0, UserName, DatabaseName,IMASMajorVersion )

 

 

opening a data-entry

(MDSplus backend)

A sequence of calls imas.ids(pulse, run) and open()

on newly created object

e.g.

import imas

imas_entry = imas.ids(12,1,0,0)

imas_entry.open()

sequence of calls imas.ids(pulse, run) and

open_env(UserName, DatabaseName,

IMASMajorVersion) on newly created object

e.g.

import imas

imas_entry = imas.ids(12,1)

 

A sequence of calls imas.ids(pulse, run) and open_env(UserName, DatabaseName, IMASMajorVersion) on newly created object

e.g.

import imas

imas_entry = imas.ids(12,1)

imas_entry.open_env(‘usr’, ‘test’, ‘3’)

 

writing the complete IDS
 

Method of the imas_entry object: def put(self,

occurrence=0)

e.g.

imas_entry.pf_active.put() for occurrence 0, or

imas_entry.pf_active.put(occurrence) otherwise

Method of the imas_entry object: def put(self, occurrence=0)

e.g.

imas_entry.pf_active.put() for occurrence 0, or imas_entry.pf_active.put(occurrence) otherwise
 
writing a single slice of an IDS
 

Method of the ids: def putSlice(self,

occurrence=0):

e.g.

imas_entry.pf_active.putSlice() for occurrence 0,

or imas_entry.pf_active.putSlice(occurrence)

otherwise

 

Method of the ids: def putSlice(self, occurrence=0):

e.g.

imas_entry.pf_active.putSlice() for occurrence 0, or imas_entry.pf_active.putSlice(occurrence) otherwise
 
writing only non-timed data of an IDS
 

Method of the ids: def putNonTimed(self,

occurrence=0):

e.g.

imas_entry.pf_active.putNonTimed() for

occurrence 0, or

imas_entry.pf_active.putNonTimed(occurrence)

otherwise

Deprecated 
reading the complete IDS
 

def get(self, occurrence=0):

e.g.

imas_entry.pf_active.get() for occurrence 0, or

imas_entry.pf_active.get(occurrence) otherwise

 

def get(self, occurrence=0):

e.g.

imas_entry.pf_active.get() for occurrence 0, or imas_entry.pf_active.get(occurrence) otherwise
 
reading a single slice of an IDS
 

Method of the ids: def getSlice(self,

time_requested, interpolation_method,

occurrence=0):

e.g.

imas_entry.pf_active.getSlice(0.1, 2) for

occurrence 0, or

imas_entry.pf_active.getSlice(0.1, 2,

occurrence) otherwise

 

Method of the ids:  def getSlice(self, time_requested, interpolation_method, occurrence=0):

e.g.

imas_entry.pf_active.getSlice(0.1, 2) for occurrence 0, or imas_entry.pf_active.getSlice(0.1, 2, occurrence) otherwise

imasdef.py:

UNDEFINED_INTERP

CLOSEST_ INTERP

PREVIOUS_INTERP  

LINEAR_INTERP  
copying an IDS or one of its substructure
 
 
 
flush an IDS from the cache to the disk

Method of the ids: def flushCache(self,

IDSOccurrence=0):

e.g.

25

imas_entry.pf_active.flushCache()

 

Deprecated

 
flushing all IDSes from the cache to the disk

def flushMemCache(self):

e.g.

imas_entry.flushMemCache()

 

Deprecated

 
disables temporarily the memory cache

Method of the ids: def discard(self,

IDSOccurrence=0):

e.g.

26

imas_entry.pf_active.discard()

 

Deprecated

 
discarding all IDSes

def discardMemCache(self):

eg.

imas_entry.discardMemCache()

 

Deprecated

 
deleting an IDS from a data-entry
 

Method of the ids: def deleteData(self,

occurrence=0):

e.g.

imas_entry.pf_active.deleteData() for

occurrence 0, or

imas_entry.pf_active.deletaData(occurrence)

otherwise

 

Method of the ids: def deleteData(self, occurrence=0):

e.g.

imas_entry.pf_active.deleteData() for occurrence 0, or imas_entry.pf_active.deletaData(occurrence) otherwise
 

closing a data-entry

imas_entry.close();

imas_entry.close();
 

 

 

1.4. Matlab

 

OperationAL3AL4Remarks

creating a data-entry

(MDSplus backend)

idx = imas_create(treename, pulse, run)

idx = imas_create_env( treename, pulse, run, 0, 0,

UserName, DatabaseName,IMASMajorVersion )

idx = imas_create_env( treename, pulse, run, 0, 0, UserName, DatabaseName,IMASMajorVersion )

 

 

opening a data-entry

(MDSplus backend)

idx = imas_create_env( treename, pulse, run, 0, 0,

idx = imas_create(treename, pulse, run)UserName, DatabaseName,IMASMajorVersion )

 

  idx = imas_open_env( treename, pulse, run, UserName, DatabaseName, IMASMajorversion )

 

writing the complete IDS
 ids_put(idx, IDSOccurrence, IDSVariable)

ids_put(idx, IDSOccurrence, IDSVariable)

 
writing a single slice of an IDS
 

ids_put_slice(idx, IDOccurrence,

IDSVariable)

  ids_put_slice(idx, IDOccurrence, IDSVariable)
 
writing only non-timed data of an IDS

ids_put_non_timed(idx, IDSOccurence,

IDSVariable)

Deprecated 
reading the complete IDS
 

IDSVariable = ids_get(expIdx,

IDSOccurrence)

  IDSVariable = ids_get(expIdx, IDSOccurrence)
 
reading a single slice of an IDS
 

IDSVariable = ids_get_slice(idx,

IDSOccurrence, time_requested,

interpolation_method)

  IDSVariable = ids_get_slice(idx, IDSOccurrence, time_requested, interpolation_method)
 
copying an IDS or one of its substructure
 
 
 
deleting an IDS from a data-entry
 Not implemented yet
  Not implemented yet
 

closing a data-entry

 [ cr ] = imas_close(idx)
  [ cr ] = imas_close(idx)
 

 

 

1.5. Java

 

OperationAL3AL4Remarks

creating a data-entry

(MDSplus backend)

imas.create(treename, pulse, run, 0, 0), for

example :

idx = imas.create(“ids” , 12, 1, 0, 0) ;

imas.createEnv (treename, pulse, run, 0, 0,

UserName, DatabaseName, IMASMajorVersion), for example :

idx = imas.createEnv(“ids”, 12, 1, 0, 0, “user”,

“test”, “3”) ;

imas.createEnv (treename, pulse, run, 0, 0, UserName, DatabaseName, IMASMajorVersion), for example :

idx = imas.createEnv(“ids”, 12, 1, 0, 0, “user”, “test”,  “3”) ;

 

 

opening a data-entry

(MDSplus backend)

Create IMAS entry object IdsNs::IDS

imas_entry(pulse,run,0,0); then open() on the

newly created object

e.g.

IdsNs::IDS imas_entry(12,1,0,0);

imas_entry.open();

Create IDS object IdsNs::IDS

imas_entry(pulse,run,0,0); then

openEnv(UserName, DatabaseName,

IMASMajorVersion) on the newly created object

e.g.

IdsNs::IDS imas_entry(12,1,0,0);

imas_entry.openEnv(‘usr’, ‘test’, ‘3’);

imas.openEnv(treename, pulse, run, UserName, DatabaseName, IMASVersion), for example :

idx = imas.openEnv(“ ids”, 12, 1, “user”, “test”,  “3”) ;

 

writing the complete IDS

Method of the ids: put (idx, IDSOccurrence,

IDSVariable), for example :

imas.equilibrium equilibrium = new

imas.equilibrium();

equilibrium.put(idx, “equilibrium”,

equilibrium) ;

Method of the ids: put (idx, IDSOccurrence, IDSVariable), for example :

imas.equilibrium equilibrium = new imas.equilibrium();

equilibrium.put(idx, “equilibrium”,  equilibrium) ;
 
writing a single slice of an IDS

Method of the ids: putSlice (idx, IDSOccurrence,

IDSVariable), for example :

imas.equilibrium equilibrium = new

imas.equilibrium();

equilibrium. putSlice(idx, “equilibrium”,

equilibrium) ;

Method of the ids: putSlice (idx, IDSOccurrence, IDSVariable), for example :

imas.equilibrium equilibrium = new imas.equilibrium();

equilibrium. putSlice(idx, “equilibrium”, equilibrium) ;
 
writing only non-timed data of an IDS

Method of the ids: putNonTimed (idx,

IDSOccurrence, IDSVariable), for example :

imas.equilibrium equilibrium = new

imas.equilibrium();

equilibrium.putNonTimed(idx, “equilibrium”,

equilibrium) ;

Deprecated 
reading the complete IDS

Method of the ids: get (idx, IDSOccurrence,

IDSVariable), for example :

imas.equilibrium equilibrium = new

imas.equilibrium();

equilibrium. get(idx, “equilibrium”,

equilibrium) ;

Method of the ids: get (idx, IDSOccurrence, IDSVariable), for example :

imas.equilibrium equilibrium = new imas.equilibrium();

equilibrium. get(idx, “equilibrium”,  equilibrium) ;
 
reading a single slice of an IDS

Method of the ids: getSlice (idx, IDSOccurrence,

IDSVariable, double time_requested, int

interpolation_method), for example :

imas.equilibrium equilibrium = new

imas.equilibrium();

equilibrium.getSlice(idx, “equilibrium”,

equilibrium, 0.1, 2) ;

Method of the ids: getSlice (idx, IDSOccurrence, IDSVariable, double time_requested, int interpolation_method), for example :

imas.equilibrium equilibrium = new imas.equilibrium();

equilibrium.getSlice(idx, “equilibrium”,  equilibrium, 0.1, 2) ;
 
copying an IDS or one of its substructure
 
 
 
flushing all IDSes from the cache to the disk

imas.flush (idx, IDSOccurrence), for example :

imas.flush (idx, “equilibrium/1”) ;

 

Deprecated

 
flushing all IDSes from the cache to the diskimas.flushAll(idx);

 

Deprecated

 
disables temporarily the memory cache

imas.discard (idx, IDSOccurrence), for example :

imas.discard (idx, “equilibrium”) ;

 

Deprecated

 
discarding all IDSesimas.discardAll (idx) ;

 

Deprecated

 
deleting an IDS from a data-entry

Method of the ids: delete (idx, IDSOccurrence,

IDSVariable), for example :

imas.equilibrium equilibrium = new

imas.equilibrium();

equilibrium.delete(idx, “equilibrium”,

equilibrium) ;

 

Method of the ids: delete (idx, IDSOccurrence, IDSVariable), for example :

imas.equilibrium equilibrium = new imas.equilibrium();

equilibrium.delete(idx, “equilibrium”,  equilibrium) ;
 

closing a data-entry

 imas.close(idx) ;
  imas.close(idx) ;
 

 

 

1.6. Lowlevel (C)

 

 

  • No labels