Skip to content

improve documentation, how to run and install, list of examples #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
apgodshall wants to merge 2 commits into
base: master
Choose a base branch
from
Open

improve documentation, how to run and install, list of examples #2

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ee3e5c3
improve documentation, how to run and install, list of examples
Feb 10, 2016
27d0506
openscenegraph is required for viewing result
Feb 11, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions README
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -192,12 +192,35 @@ fuselage design and construction. The shapes are different between a
wing and a fuselage, but much of the process is analogous.


HOW TO INSTALL AND RUN
======================

1. If you don't have Python, install it (python.org)

2. If you don't have OpenSceneGraph, install it
( Example for Debian or Ubuntu, as root or with sudo:
apt-get install openscenegraph )

2. Install required python libraries: numpy polygon2 svgwrite openscenegraph
( Example for Debian or Ubuntu, as root or with sudo:
apt-get install python-numpy python-pip python2.7-dev
pip install polygon2
pip install svgwrite )

3. Get madesigner and unpack it someplace
( Use git or untar or unzip or your favorite pointy clicky programs )

4. Get a command prompt, cd to the directory, and run:
python madesigner.py


FREQUENTLY ASKED QUESTIONS
==========================

Here's a quick FAQ (although no one has yet asked me any questions, so I'm
just trying to anticipate what people might be thinking.)


Q: Are you a moron? Haven't you hear of profili (or "xxx" cad program)???

Yes, and I've probably heard of the suggested tool too. :-)
Expand Down
13 changes: 13 additions & 0 deletions examples/list_of_examples.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
example01.mad A very simple example
example02.mad Beginning to add typical wing structures.
example03.mad This example begins to add a bit of complexity to show the power of MA designer.
example04.mad Swept wings are no problem.
example05.mad This example demonstrates how easy it is to create a wing that blends from one airfoil at the root to a completely different airfoil at the tip.
example06.mad This example shows how easy it is to create a complex curved wing using a spline curve to define the cord relative to the span of the wing.
example07.mad This example shows how easy it is to create a wing with a curved sweep.
example08.mad Back to a simpler wing plan, but now lets put the ribs where we want them by entering our own station values.
example09.mad With a simple wing plan and custom station positions, let's start adding more features to our wing.
example10.mad We can skin the wing for sheeting. Sheet position at the time of this example is limited, but this example shows typical "D" construction wing sheeting.
example11.mad Stations! Any feature can start and end at any station. You are the engineer and get to decide what you want, how big, and where it starts and ends.
example12.mad This example adds flaps and ailerons to a tapered wing.
example13.mad This example shows how to build a multi-panel, polyhedral wing. In this case the mh43 glider airfoil is chosen. Notice in the Outer wing tab that the panel is "linked" to the "Inner" wing.
8 changes: 8 additions & 0 deletions examples/mkexampleslist.bash
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
#!/bin/bash

for f in example*mad
do
echo $f $(grep description $f|perl -pe 's{^ *}{};s{<[^<>]+>}{}g'|head -n1)
done \
> list_of_examples.txt