orcina/orcaflex repository overview

This repository provides official Docker images to run Python applications using the OrcaFlex API (OrcFxAPI) in both Windows and Linux environments.

⁠Windows Images (:win2019, :win2022)

Based on Windows Server Core (win2019 and win2022 tags)

Includes last 3 OrcaFlex versions: 11.3, 11.4, 11.5

Includes Python 3.9 to 3.13 (64-bit)

FLEXNET_ADDRESS environment variable is required to connect to your FlexNet licence server

Optional variables:

• PYTHON_VERSION (e.g. 3.10)

• ORCAFLEX_VERSION (e.g. 11.4)

Entrypoint script auto-configures Python, OrcaFlex and FlexNet.ini

Example:

docker run -e FLEXNET_ADDRESS=myfnserver -e PYTHON_VERSION=3.10 -e ORCAFLEX_VERSION=11.4 -it orcina/orcaflex:win2019 python

⁠Linux Images via Wine (:ofx###x-py###)

Based on Ubuntu 22.04 (Jammy) with Wine

Each tag encodes a fixed OrcaFlex and Python version (e.g. ofx115c-py311 = OrcaFlex 11.5c, Python 3.11)

Supports same OrcaFlex and Python versions as Windows images

Requires FLEXNET_ADDRESS to configure FlexNet.ini at container startup

Additional supported environment variables:

• ENTRYPOINT_VERBOSE = 1 (for debug output)

• WINEDEBUG (to override Wine log settings)

• FLEXNET_SERVICE_WAIT_SECONDS (to tune internal licence service wait time, default is 5s)

Example:

docker run -e FLEXNET_ADDRESS=myfnserver -it orcina/orcaflex:ofx115c-py310 python

As part of the build process, we create a wrapper script to bind the python and the pip commands in the linux shell to the WINE execution of these commands (python3 still starts the default Linux Python). This means that doing pip install pandas either in a RUN command in a Dockerfile or directly in the shell will load pandas into the correct interpreter.

=== Use Cases ===

Run OrcFxAPI scripts in isolation

Deploy containerised simulation workflows

Reduce licensing overhead in Linux-based HPC clusters