openfast-service

A simple wrapper around OpenFAST to run it as a Twined data service in the cloud. Uses the official OpenFAST docker image architected by Octue as a base image.

Installation

Install the client

pip install octue

Set up the data service

There are two main options:

• Self-hosting - use our open-source tools to spin up an OpenFAST service in your own private cloud:
  • Twined Terraform module to spin up the cloud infrastructure
  • Octue Twined data service framework to trigger OpenFAST simulations
• Octue hosting - we sort everything for you

Usage

from octue.resources import Child, Manifest


# Point to your data service
child = Child(
    id="my-org/openfast-service:0.9.0",
    backend={"name": "GCPPubSubBackend", "project_name": "my-project"},
)

# Point to your input data
input_manifest = Manifest(datasets={"openfast": "gs://my-bucket/path/to/openfast_dataset"})

# Run the OpenFAST analysis
answer, _ = child.ask(input_manifest=input_manifest, timeout=3600)

# Access the output data
output_dataset = answer["output_manifest"].get_dataset("openfast")

OpenFAST versions

openfast-service is versioned separately to OpenFAST. See below for the default version of OpenFAST each version of the service supports.

openfast-service versions	OpenFAST version
<=0.9.0	3.5.3