summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--README.org24
-rw-r--r--creator/__init__.pycbin0 -> 311 bytes
-rw-r--r--doc/diagram5
-rw-r--r--doc/diagram.pngbin0 -> 5111 bytes
-rw-r--r--example_airfoil.py2
-rw-r--r--example_airfoil.pycbin0 -> 1581 bytes
-rw-r--r--resources/__init__.py0
-rw-r--r--resources/__init__.pycbin0 -> 147 bytes
-rw-r--r--resources/materials.pycbin0 -> 348 bytes
9 files changed, 30 insertions, 1 deletions
diff --git a/README.org b/README.org
index a2cb900..562423f 100644
--- a/README.org
+++ b/README.org
@@ -1,5 +1,6 @@
#+TITLE: Aircraft Studio
#+AUTHOR: Marius Peter
+#+EMAIL: mpeter@ucla.edu
This program enables the creation of NACA airfoils;
the analysis of the airfoil's structural properties;
@@ -7,3 +8,26 @@ the optimization via genetic algorithm of a population of airfoils;
With the final objective of designing a lightweight FAR 23 compliant airfoil.
I adapted it from my own code for the UCLA MAE 154B final project (Spring 2019).
+
+* Program Structure
+
+** =creator.py=
+ This module enables the creation of discrete aircraft components.
+
+** =evaluator.py=
+
+** =generator.py=
+ The =generator= module contains classes describing aircrafts comprised
+ of sufficient =creator= components that they can be fed to the =evaluator=
+ for useful analysis.
+
+* Program Flow
+
+ 1. Create an =evaluator= object
+ 2. Populate the =evaluator= with aircrafts by either:
+ 1. Using =generator= methods to create an aircraft from a template
+ 2. Using =creator= to manually describe all aircraft components
+ 3. Use =evaluator= methods to:
+ 1. Calculate relevant aircraft properties
+ 2. Set desired optimization parameter(s)
+ 3. Execute the genetic algoritm and return an optimized aircraft
diff --git a/creator/__init__.pyc b/creator/__init__.pyc
new file mode 100644
index 0000000..022f493
--- /dev/null
+++ b/creator/__init__.pyc
Binary files differ
diff --git a/doc/diagram b/doc/diagram
new file mode 100644
index 0000000..6140981
--- /dev/null
+++ b/doc/diagram
@@ -0,0 +1,5 @@
+hide footbox
+title Sequence Diagram (Footer removed)
+
+Alice -> Bob: Authentication Request
+Bob --> Alice: Authentication Response
diff --git a/doc/diagram.png b/doc/diagram.png
new file mode 100644
index 0000000..142f1b6
--- /dev/null
+++ b/doc/diagram.png
Binary files differ
diff --git a/example_airfoil.py b/example_airfoil.py
index 14cf916..3488eb9 100644
--- a/example_airfoil.py
+++ b/example_airfoil.py
@@ -69,7 +69,7 @@ af.spar2 = creator.wing.Spar(af, 0.57, mt.aluminium)
# af.stringer.info_save(SAVE_PATH, 'foo_name')
# Plot components with matplotlib
-# wing.plot_geom(af, [af.spar1, af.spar2], None)
+# creator.wing.plot_geom(af, [af.spar1, af.spar2], None)
# Evaluator object contains airfoil analysis results.
eval = evaluator.Evaluator(aircraft)
diff --git a/example_airfoil.pyc b/example_airfoil.pyc
new file mode 100644
index 0000000..54505a3
--- /dev/null
+++ b/example_airfoil.pyc
Binary files differ
diff --git a/resources/__init__.py b/resources/__init__.py
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/resources/__init__.py
diff --git a/resources/__init__.pyc b/resources/__init__.pyc
new file mode 100644
index 0000000..cdb6635
--- /dev/null
+++ b/resources/__init__.pyc
Binary files differ
diff --git a/resources/materials.pyc b/resources/materials.pyc
new file mode 100644
index 0000000..a6c1af9
--- /dev/null
+++ b/resources/materials.pyc
Binary files differ
Copyright 2019--2024 Marius PETER