Add WEIS file readers and writers

.github/workflows/build-docker-image-automatic.yml → .github/workflows/deploy.yml

@@ -1,16 +1,41 @@
-# This workflow builds an OpenFAST docker image for the linux/amd64 and linux/aarch64 architectures on merge into
-# `main` from a release candidate branch. The image is tagged both with "latest" and the version extracted from the
-# release candidate branch's name (e.g. "rc-3.5.3") before being pushed to the `nrel/openfast` repository. The build
-# cache is stored in GitHub actions.
-name: build-docker-image-automatic
+# This workflow uploads the `openfast` python package to PyPI before building an OpenFAST docker image for the
+# linux/amd64 and linux/aarch64 architectures on release. The image is tagged both with "latest" and the version
+# extracted from the release candidate branch's name (e.g. "rc-3.5.3") before being pushed to the `nrel/openfast`
+# repository. The build cache is stored in GitHub actions.
+name: deploy
 
 on:
+  workflow_dispatch:
+
   release:
     types:
       - released
 
 jobs:
-  build-and-push:
+  publish-to-pypi:
+    runs-on: ubuntu-latest
+    permissions:
+      id-token: write
+      contents: read
+
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v4
+
+      - name: Install Poetry
+        uses: snok/install-poetry@v1.3.4
+
+      - name: Build a binary wheel and a source tarball
+        run: poetry build
+        working-directory: openfast_python
+
+      - name: Publish package distributions to PyPI
+        uses: pypa/gh-action-pypi-publish@v1.8.14
+        with:
+          packages-dir: openfast_python/dist
+
+
+  docker-build-and-push:
     runs-on: ubuntu-latest
     timeout-minutes: 300
     env:

.gitignore

@@ -43,6 +43,7 @@ vs-build/
 .fortls
 .devcontainer
 .idea
+.env
 
 # backup files
 *.asv

docs/source/install/index.rst

@@ -15,6 +15,9 @@ code,** refer to the table in the :ref:`download_binaries` or :ref:`use_docker`
 sections and read the corresponding documentation for specific instructions.
 For instructions on compiling, see :ref:`compile_from_source`.
 
+To manipulate OpenFAST files using python, see :ref:`python_wrapper`.
+
+
 .. _download_binaries:
 
 Download binaries
@@ -193,13 +196,13 @@ To pull and run with local files:
 
 .. code-block:: shell
 
-    docker run --rm -it --volume=/path/to/files:/files ghcr.io/OpenFAST/openfast:latest openfast /files/main.fst
+    docker run --rm -it --volume=/path/to/files:/files ghcr.io/openfast/openfast:latest openfast /files/main.fst
 
 For running the container interactively:
 
 .. code-block:: shell
 
-    docker run --rm -it --volume=/path/to/files:/files ghcr.io/OpenFAST/openfast:latest /bin/bash
+    docker run --rm -it --volume=/path/to/files:/files ghcr.io/openfast/openfast:latest /bin/bash
 
 
 Build your own images
@@ -208,6 +211,26 @@ You can also build your own custom images using our `Dockerfile` or base your im
 `here <https://github.com/OpenFAST/openfast/blob/main/share/docker/README.md>`_ for more information on this.
 
 
+.. _python_wrapper
+
+Install the ``openfast_io`` python wrapper
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+The ``openfast_io`` python package is a wrapper comprising readers and writers for converting OpenFAST files to/from
+python objects. You can install it with:
+
+.. code-block::
+
+    pip install openfast_io
+
+or
+
+.. code-block::
+
+    poetry add openfast_io
+
+For more information and installation options, see `here <https://github.com/OpenFAST/openfast/blob/main/openfast_python/README.md>`_.
+
+
 .. _compile_from_source:
 
 Compile from source

openfast_python/README.md

@@ -0,0 +1,27 @@
+# OpenFAST python readers/writers
+
+> [!CAUTION]
+> The `openfast_io` package on PyPI is currently called `octue-openfast` but will soon be renamed.
+
+This package is a python wrapper comprising readers and writers for converting OpenFAST files to/from python objects. It
+was originally written for [WEIS](https://github.com/WISDEM/WEIS/tree/77a878d7989b8c1d07d2244135ccd308a193a924/weis/aeroelasticse) and has been ported over to OpenFAST to make it more widely accessible. 
+
+## Installation
+Run either
+```shell
+pip install openfast_io
+```
+or
+```shell
+poetry add openfast_io
+```
+
+### Extra options
+[ROSCO](https://github.com/NREL/ROSCO) can be installed as an optional dependency. Run either
+```shell
+pip install openfast_io[rosco]
+```
+or
+```shell
+poetry add -E rosco openfast_io
+```