Project directory¶
As seen in the first tutorial (Getting started), PyTornado has its own project directory with several subfolders. PyTornado can automatically generate the folder structure if necessary. This is what the folder structure typically looks like:
Folders and files¶
settings The settings folder must contain a JSON settings file. This file is the entry point for any VLM analysis. Notice that you already referenced a settings file in the first tutorial with the --run argument (Getting started). The settings file can be named arbitrarily.
See also
More information on the settings file can be found here: Settings file
aircraft This folder contains a file with the aircraft model. PyTornado reads models stored as JSON or CPACS files.
See also
More information on aircraft files can be found here: Aircraft file
airfoils This folder can contain files with airfoil descriptions. Airfoil files can be referenced from the aircraft model (JSON or CPACS). Airfoil files may be automatically generated if you use CPACS. Also, if you use PyTornado’s JSON format, you can define NACA airfoils without adding any files yourself.
See also
More information on airfoil files can be found here: Airfoil files
state The state directory must contain a file which describes the flight state (or aero-performance map) which is to be analysed.
See also
More information on state files can be found here: State file
_results This folder and its content are generated during program execution. Numerical results will be stored in files which can be used for further processing. (See Output files)
_plots Plots can be stored as image files. Plots generated during program execution will be stored in the _plots folder. (See Output files)
log.txt This is an automatically generated log file. It contains information about the program execution. Normally, it it only of interest if something went wrong. Then, this log file may contain helpful information.
Note
If you plan to perform analyses for multiple aircraft models, you can separate your analyses by using separate project directories (the top level folder). Alternatively, it is also possible to keep all analyses in one project folder. Then, you will have multiple settings files in the settings folder, multiple aircraft files in your aircraft folder etc.
Hint
The leading underscores in the folder names _results and _plots indicate that the folder contents are generated as part of a VLM analysis. The command line arguments --clean and --clean-only will delete content in these folders, but other folders remain unaffected (see also The command line interface).