Structure for modules scripts #61

ebranlard · 2023-02-13T18:57:59Z

ebranlard
Feb 13, 2023
Maintainer

We'll likely add more and more scripts for specific modules (e.g. tools for AeroDyn, ElastoDyn, SubDyn, etc.).

We are looking for some feedback on where those tools should be placed. Here's some line of thoughts:

A shorter syntax is likely preferable for the user.
Having everything into only one file for each module could be a bit overwhelming.
Currently the fast-farm tools are located in pyFAST/fast-farm/*.py
a structure of the form pyFAST/modules/elastodyn mimics the openfast repository, but is longer to type.

Where do you think the module-specific tools should be located? (example here for ElastoDyn)

pyFAST/elastodyn.py (`from pyFAST.elastodyn import *`)

0%

pyFAST/modules/elastodyn.py (`from pyFAST.modules.elastodyn import *`)

25%

pyFAST/modules/elastodyn/__init__.py and pyFAST/modules/elastodyn/some_tools.py (`from pyFAST.modules.elastodyn import *`)

0%

pyFAST/elastodyn/__init__.py and pyFAST/elastodyn/some_tools.py (`from pyFAST.elastodyn import *`)

75%

4 votes

andrew-platt · 2023-02-13T19:01:28Z

For option 2, are you thinking of a glue-codes as well (for FAST.Farm, OpenFAST, etc)?

1 reply

Good point, I've added a note on that. Currently the fast-farm tools are located in pyFAST/fast-farm/*.py

ebranlard · 2023-11-27T22:36:17Z

pyFAST has been renamed to openfast_toolbox and migrated here: https://github.com/OpenFAST/openfast_toolbox .

Please continue the discussion in this new repository. Sorry for the inconvenience.

0 replies