Automation: Introduction

OrcaWave provides important facilities for automating and post-processing work.

Batch processing

The batch processing facility enables you to run a set of calculations in unattended mode, for example as an overnight job.

OrcFxAPI

OrcaFlex includes a well-documented programming interface called OrcFxAPI (short for OrcaFlex Application Program Interface) which can also interface with OrcaWave. OrcFxAPI is a Windows dynamic link library (DLL) that provides facilities for programatically setting data, performing calculations and extracting results. Other examples of using OrcFxAPI include linking to other modelling software. For further information or to discuss possible applications of OrcFxAPI, please contact Orcina.

Interfaces to Python and MATLAB are both included in the OrcaWave installation. We recommend these as the easiest ways to drive OrcaWave through OrcFxAPI.

The OrcFxAPI documentation is organised according to the different language interfaces. For example:

• The Python section covers setting data items, performing a calculation and extracting results using the OrcFxAPI module.
• The MATLAB section covers setting data items, performing a calculation and extracting results using the ofx and ofxDiffraction classes.
• Instructions on how to link to the DLL using C++ and Delphi are also provided in full. The same functionality is available in these languages, and we recommend using C++ or Delphi for integrating OrcaWave with other software, but the Python or MATLAB interfaces are usually better suited to automation and scripting tasks.