openfast_io 5.0.0

Readers and writers for OpenFAST files.

OpenFAST python readers/writers

This package is a python wrapper comprising readers and writers for converting OpenFAST files to/from python objects. It was originally written for WEIS and has been ported over to OpenFAST to make it more widely accessible.

Installation

Installation with Anaconda is the recommended approach because of the ability to create self-contained environments suitable for testing and analysis.

Installation as a "library"

To use openfast_io as a library for incorporation into other scripts or tools, it is available via (assuming that you have already setup your python environment):

pip install openfast_io

Installation as an editable library

These instructions are for interaction directly with the openfast_io source code.

0. Follow this step only if you have not cloned the OpenFAST repo.

   git clone https://github.com/OpenFAST/OpenFAST.git
   cd OpenFAST
   

1. Assuming you are within the OpenFAST directory.

   cd openfast_io
   pip install -e .
   

2. To test openfast_io, OpenFAST must be compiled within the build folder, then run:

   cd tests
   pytest test_of_io_pytest.py
   

Extra options

ROSCO can be installed as an optional dependency. Run either

pip install openfast_io[rosco]

Development and testing

To contribute to the development of openfast_io, install additioal depemndancies using:

pip install -e ".[all]"