Skip to content

Commit 281dd9a

Browse files
develop guide
1 parent 7882351 commit 281dd9a

File tree

1 file changed

+13
-4
lines changed

1 file changed

+13
-4
lines changed

develop.md

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,14 @@ Development is done on separate branches. Our branching model is very similar t
2424

2525
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.
2626

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+
2735
### Prerequisites
2836

2937
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
190198
| Weights correlations |Implemented for tube/wing, blended wing body, and human powered/solar.|
191199
| Loads | No methodology for loads determination. Need a V-n diagram.|
192200
| Finite Element Modeling |FEM-based primary structure weight estimations would be useful for unconventional configurations.|
193-
| **Geometry**| **High Priority** |
201+
| **Geometry**| **- - High Priority - -** |
194202
| Parametric Geometry|Not currently in SUAVE.|
195203
| Connection to OpenVSP |Not currently in SUAVE.|
196204
| Geometry Visualization |Not currently in SUAVE.|
197205
| Fuselage Layout | Basic methods in place for Tube/Wing and BWB. More general methods desired. |
198-
| **Optimization**||
206+
| **Optimization**| |
199207
| Optimization Interfaces | Framework defined, initial implementation in place. Undergoing development. |
200208
| Response Surfaces | Automatic method not yet implemented. |
201209
| Uncertainty Management | Planning to use Dakota to accomplish this. |
202-
| **Input/Output** ||
210+
| **Input/Output** | |
203211
| Data visualization | Looking for [D3.JS](http://d3js.org/) development. |
204212
| Design templates | Not implemented. |
205-
| **Miscellaneous** ||
213+
| **Miscellaneous** | |
206214
| Multifidelity Approaches | Framework identified, undergoing developent. Suggestions welcomed. |
207215
| Aeroelastic Constraints | Under consideration, in early development. |
208216
| Interface to BAD3/4, AEDT | Under development. |
217+
209218
<br>
210219

211220
Back to [Top](#background)!

0 commit comments

Comments
 (0)