Python interface: Running models

To open an existing OrcaFlex file with the Python interface you can create a new Model object with a file name as a constructor parameter:

or similarly for a simulation file:

Alternatively you can use an existing Model instance and open a data file like this:

Similarly for a simulation file:

To run a simulation (which also calculates statics if the model is in reset state), use:

To calculate statics only use the call:

You can determine what state the model is in by reading the state property of the model:

This will return a value such as Reset or SimulationStopped.

To save a simulation or data file use one the following calls:

Results can now be extracted from the model object, see Python interface: Results

OrcaFlex Batch Scripts

Normally using the OrcaFlex spreadsheet is the most effective way of creating and running batch scripts and post-processing the results, but this can also be done through the Python API if neccessary. Use the ProcessBatchScript command of the model object, for example:

Progress Reporting and Cancelling

If progress updates are required then progress handlers can be set for statics, dynamics, processing batch scripts and other TOrcFxAPIHandle operations, see Progress handlers. The progress handler also gives an opportunity to cancel or pause a long running operation, the following example sets a dynamics progress handler: