You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: develop.md
+13-4Lines changed: 13 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -24,6 +24,14 @@ Development is done on separate branches. Our branching model is very similar t
24
24
25
25
SUAVE merges new code contributions through [pull requests](https://help.github.com/articles/creating-a-pull-request). As you make changes to your copy of SUAVE, you'll upload them to your GitHub fork, and then when they're ready for review you'll submit them for merge via pull request.
26
26
27
+
### Style Guide
28
+
29
+
SUAVE is built on a slightly modified PEP8 style guide, with changes made to implement a data-oriented view of the code. To help support discovering code, the SUAVE folder structure explicitly mirrors the package structure. Flexibility of the package structure is important, so in general all objects live in their own file, with the same file name as the object name. In order to maintain a separation between Analysis and Data structures, there are often parallel package trees inside the main branches of the package, like SUAVE.Methods.Aerodynamics and SUAVE.Analysis.Aerodynamics. Where possible the names of fields that live in the SUAVE package are written out verbosely, avoiding jargon built on mathematical variable names or acronyms.
30
+
31
+
Templates for new methods and objects can be found in the SUAVE repo's [templates](https://github.com/suavecode/SUAVE/tree/develop/templates) folder.
32
+
33
+
More detail on the style of SUAVE can be found on the [wiki](https://github.com/suavecode/SUAVE/wiki/Style-Guide).
34
+
27
35
### Prerequisites
28
36
29
37
In addition to the package dependencies listed on the [download](/download#dependencies) page, you will need to install git.
@@ -190,22 +198,23 @@ These are the areas that are under development, including their status, and what
190
198
| Weights correlations |Implemented for tube/wing, blended wing body, and human powered/solar.|
191
199
| Loads | No methodology for loads determination. Need a V-n diagram.|
192
200
| Finite Element Modeling |FEM-based primary structure weight estimations would be useful for unconventional configurations.|
193
-
|**Geometry**|**High Priority**|
201
+
|**Geometry**|**- - High Priority - -**|
194
202
| Parametric Geometry|Not currently in SUAVE.|
195
203
| Connection to OpenVSP |Not currently in SUAVE.|
196
204
| Geometry Visualization |Not currently in SUAVE.|
197
205
| Fuselage Layout | Basic methods in place for Tube/Wing and BWB. More general methods desired. |
0 commit comments