From 13d3e4c648036f6e26d450c4dfdbd4999cf0e8a8 Mon Sep 17 00:00:00 2001 From: blendoit Date: Fri, 4 Oct 2019 13:09:31 -0700 Subject: Ignore pyc files and update docs --- .gitignore | 3 ++- README.org | 4 ++++ doc/diagram.txt | 17 +++++++++++++++++ doc/diagram2.png | Bin 0 -> 6107 bytes doc/diagram2.pum | 5 +++++ example_airfoil.py | 4 ++-- example_airfoil.pyc | Bin 1581 -> 0 bytes 7 files changed, 30 insertions(+), 3 deletions(-) create mode 100644 doc/diagram.txt create mode 100644 doc/diagram2.png create mode 100644 doc/diagram2.pum delete mode 100644 example_airfoil.pyc diff --git a/.gitignore b/.gitignore index 225020c..713d0d7 100644 --- a/.gitignore +++ b/.gitignore @@ -1,8 +1,9 @@ # .gitignore **/__pycache__/ +**/*.pyc **/log.txt **/*.html **/*.pdf **/*.tex save/ -TAGS \ No newline at end of file +TAGS diff --git a/README.org b/README.org index eaed041..9ce7891 100644 --- a/README.org +++ b/README.org @@ -13,6 +13,10 @@ I adapted it from my own code for the UCLA MAE 154B final project (Spring 2019). #+NAME: fig:Test-Image [[./doc/diagram.png]] +#+CAPTION: Second test image for the README +#+NAME: fig:Test-Image2 +[[./doc/diagram2.png]] + * Program Structure ** =creator.py= diff --git a/doc/diagram.txt b/doc/diagram.txt new file mode 100644 index 0000000..668ec61 --- /dev/null +++ b/doc/diagram.txt @@ -0,0 +1,17 @@ + ┌─────┐ ┌───┐ ┌────┐ + │Alice│ │Bob│ │John│ + └──┬──┘ └─┬─┘ └─┬──┘ + │Authentication Request │ │ + │───────────────────────>│ │ + │ │ │ + │Authentication Response │ │ + │<─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─│ │ + │ │ │ + │ another Authentication Request │ + │<─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ │ + │ │ │ + │ another Authentication Response │ + │ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─>│ + ┌──┴──┐ ┌─┴─┐ ┌─┴──┐ + │Alice│ │Bob│ │John│ + └─────┘ └───┘ └────┘ diff --git a/doc/diagram2.png b/doc/diagram2.png new file mode 100644 index 0000000..f15fa91 Binary files /dev/null and b/doc/diagram2.png differ diff --git a/doc/diagram2.pum b/doc/diagram2.pum new file mode 100644 index 0000000..4eb26a6 --- /dev/null +++ b/doc/diagram2.pum @@ -0,0 +1,5 @@ +' this is a comment +Alice -> Bob: Authentication Request +Bob --> Alice: Authentication Response +John --> Alice: another Authentication Request +Alice --> John: another Authentication Response diff --git a/example_airfoil.py b/example_airfoil.py index 3488eb9..e975483 100644 --- a/example_airfoil.py +++ b/example_airfoil.py @@ -55,8 +55,8 @@ af.spar1 = creator.wing.Spar(af, 0.23, mt.aluminium) af.spar2 = creator.wing.Spar(af, 0.57, mt.aluminium) # af.spar1.info_print(2) # af.spar2.info_print(2) -# af.spar1.info_save(SAVE_PATH, 'spar1') -# af.spar2.info_save(SAVE_PATH, 'spar2') +af.spar1.info_save(SAVE_PATH, 'spar1') +af.spar2.info_save(SAVE_PATH, 'spar2') # # Create stringer instance # af.stringer = wing.Stringer() diff --git a/example_airfoil.pyc b/example_airfoil.pyc deleted file mode 100644 index 54505a3..0000000 Binary files a/example_airfoil.pyc and /dev/null differ -- cgit v1.2.3