How to run a Python script within an Ocean script and return results to ADE Assembler?

I've done pretty extensive work on this exact process you're describing!

From what I've learned, there's two options for running a python/cadence pipeline: 
- cdspythonsrrkit 
- ipc/shell processes

For the first point, to quote a previous discussion post reply from Andrew Beckett:

"One thing that would help is to use the cdspythonsrr kit that is shipped in Virtuoso since IC23.1 ISR12 - see What’s New in Virtuoso IC23.1 ISR12. Previously we had a standalone kit that had to be requested specially, but now we ship a form of it with the software. This allows you to directly read simulation results from Spectre in Python."

Personally, I've done most of my work on the second bulletpoint, the ipc process.

To summarize the pipeline, I take all of the data I am trying to send over (waveforms, vectors, scalars etc), and translate it to JSON with a skill script I created. Any vectors / large lists / waveforms are saved to their own CSV's. This is then fed to a parent python process , and converts JSON to python native variable types.

Like Andrew notes, ipc was really not meant for transferring large data, so I use it more as an ignition of the desired script, and to pass ACK/ERR markers. 

Hope this helps,

Trevor Farias

Hello Trevor,

Thank you very much for your helpful comments. Do you have any example code that I could use? For instance, in the case you mentioned, you took all of the data you wanted to send (waveforms, vectors, scalars, etc.) and converted it to JSON using a SKILL script you created. Which specific IPC processes did you use?

Thank you again,

Nikos Vasiliadis

Unfortunately I can't give any code, but if you want a super simple barebones example read up on python subprocesses, then simply create an ipc process, save any data you might need to transfer over to a csv / group of csv's, pass those paths through the processes stdout/stdin and pass the results from python back.

The IPC Processes needed are ipcCreateProcess, ipcReadProcess, ipcWriteProcess and ipcWaitForProcess. 

You will need a readCsv and writeCsv procedure to aid with this, here's what I did (I can't speak to the efficiency of them):

procedure( waveformToCsv( waveid file_path )
let(( xvec yvec len fp )
xvec = drGetWaveformXVec(waveid )
yvec = drGetWaveformYVec(waveid )

when( or( null(xvec) null(yvec))
error("invalid waveforms")
)

len = min( drVectorLength(xvec) drVectorLength(yvec))
fp = outfile(file_path)
unless(portp(fp)
error("couldnt open file")
)

for( i 0 len-1
fprintf(fp "%.15g,%.15g\n" drGetElem(xvec i) drGetElem(yvec i)
)
close(fp)
)
)
)

procedure( csvToWaveform(file_path)
prog( (inFile xList yList nextLine)
xList = '()
yList = '()
inFile = infile(file_path)
unless(inFile
printf("Error. File not found")
return()
)
when( inFile
while( gets(nextLine inFile)
nextLine = parseString(nextLine ",")
if(numberp(cdfParseFloatString(nth(0 nextLine))) then
xList = cons(atof(nth(0 nextLine)) xList)
yList = cons(atof(nth(1 nextLine)) yList)
)
)

close(inFile)
xList = reverse(xList)
yList = reverse(yList)
return(drCreateWaveform(drCreateVec('double xList) drCreateVec('double yList)))
)
)
)

Thanks, 
Trevor

Unfortunately I can't give any code, but if you want a super simple barebones example read up on python subprocesses, then simply create an ipc process, save any data you might need to transfer over to a csv / group of csv's, pass those paths through the processes stdout/stdin and pass the results from python back.

The IPC Processes needed are ipcCreateProcess, ipcReadProcess, ipcWriteProcess and ipcWaitForProcess. 

You will need a readCsv and writeCsv procedure to aid with this, here's what I did (I can't speak to the efficiency of them):

procedure( waveformToCsv( waveid file_path )
let(( xvec yvec len fp )
xvec = drGetWaveformXVec(waveid )
yvec = drGetWaveformYVec(waveid )

when( or( null(xvec) null(yvec))
error("invalid waveforms")
)

len = min( drVectorLength(xvec) drVectorLength(yvec))
fp = outfile(file_path)
unless(portp(fp)
error("couldnt open file")
)

for( i 0 len-1
fprintf(fp "%.15g,%.15g\n" drGetElem(xvec i) drGetElem(yvec i)
)
close(fp)
)
)
)

procedure( csvToWaveform(file_path)
prog( (inFile xList yList nextLine)
xList = '()
yList = '()
inFile = infile(file_path)
unless(inFile
printf("Error. File not found")
return()
)
when( inFile
while( gets(nextLine inFile)
nextLine = parseString(nextLine ",")
if(numberp(cdfParseFloatString(nth(0 nextLine))) then
xList = cons(atof(nth(0 nextLine)) xList)
yList = cons(atof(nth(1 nextLine)) yList)
)
)

close(inFile)
xList = reverse(xList)
yList = reverse(yList)
return(drCreateWaveform(drCreateVec('double xList) drCreateVec('double yList)))
)
)
)

Thanks, 
Trevor