Skip to content

Commit

Permalink
Adding documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
crecine committed Mar 18, 2024
1 parent 7a5b738 commit 24d03fe
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 0 deletions.
3 changes: 3 additions & 0 deletions aviary/docs/developer_guide/coding_standards.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,9 @@ To set up pre-commit in your development python environment, there are a few one

The Aviary repository contains a configuration file that defines what is run when commits are made and with what options enabled. Currently this is limited to autopep8 with a max line length restriction.

### Controlling Display Levels
To make debugging issues easier, it is strongly recommended to make use of the `VERBOSITY` setting. This allows control over how much information is displayed to a user; too much information makes finding relevant information difficult and not enough information can make tracking difficult. `Brief` should be the default in most cases; however, `Quiet` should be the default for tests.

## Naming Conventions
### Variables
When it comes to variable naming, always be verbose! The Aviary team considers long but clear and descriptive names superior to shortened or vague names. Typing out a long name is only difficult once, as most IDEs will help you auto-complete long variable names, but the readability they add lasts a lifetime!
Expand Down
6 changes: 6 additions & 0 deletions aviary/docs/user_guide/troubleshooting.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,12 @@ Once you get good results with the simple mission and understand the results, yo

### Interpreting optimized results

```{note}
A `VERBOSITY` control has been added to minimize the amount of unnecessary information that will be displayed.
Currently Quiet, Brief [default], Verbose, and Debug are supported. Quiet will suppress practically everything other than warnings and errors. Verbose will include information such as the progress of the optimization, instead of just a final summary. And Debug will contain detailed information about many of the steps as they happen.
Some of Aviary's CLI functions, such as `fortran_to_aviary`, allow the verbosity to be set directly with a command line argument. `run_mission` uses the variable `settings:verbosity` to control the print levels.
```

Once you've built up an understanding of your model and have successfully performed optimization, you can start to interpret the results.
This is where a mix of aircraft engineering knowledge and optimization knowledge is extremely helpful.

Expand Down

0 comments on commit 24d03fe

Please sign in to comment.