Skip to content

Commit ccef6d8

Browse files
planesplanes
committed
adding documentation tab
1 parent 2fa6c80 commit ccef6d8

File tree

1,886 files changed

+207425
-4594
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

1,886 files changed

+207425
-4594
lines changed

‎_includes/left-nav.html

+1
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ <h1 class="greetings">{{ site.greetings }}</h1>
1010
<li><a class="btn page-link {% if page.url == '' %}active{% endif %}" href="/">About</a></li>
1111
<li><a class="btn page-link {% if page.url == '/download/' %}active{% endif %}" href="/download/">Download</a></li>
1212
<li><a class="btn page-link {% if page.url == '/guides/' or page.categories != nil %}active{% endif %}" href="/guides/">Guides</a></li>
13+
<li><a class="btn page-link {% if page.url == '/documentation/' or page.categories != nil %}active{% endif %}" href="/documentation/">Documentation</a></li>
1314
<li><a class="btn page-link {% if page.url == '/develop/' %}active{% endif %}" href="/develop/">Develop</a></li>
1415
<li><a class="btn page-link {% if page.url == '/forum/' %}active{% endif %}" href="/forum/">Forum</a></li>
1516

‎_sass/_layout.scss

+1
Original file line numberDiff line numberDiff line change
@@ -288,6 +288,7 @@
288288

289289
}
290290

291+
291292
.disqus-comment-count {
292293
}
293294

‎_site/develop/index.html

+36-221
Large diffs are not rendered by default.

‎_site/documentation/index.html

+200
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,200 @@
1+
<!DOCTYPE html>
2+
<html>
3+
<head>
4+
<meta charset="utf-8">
5+
<meta http-equiv="X-UA-Compatible" content="IE=edge">
6+
<meta name="viewport" content="width=device-width, initial-scale=1">
7+
8+
<title>SUAVE</title>
9+
<meta name="description" content="A multi-fidelity conceptual design environment. Its purpose is to credibly produce conceptual-level design conclusions for future aircraft incorporating advanced technologies.
10+
">
11+
12+
<link rel="stylesheet" href="/css/main.css">
13+
<link rel="canonical" href="http://suavecode.github.io//documentation/">
14+
<link rel="alternate" type="application/rss+xml" title="SUAVE" href="http://suavecode.github.io//feed.xml" />
15+
<link href='http://fonts.googleapis.com/css?family=Open+Sans' rel='stylesheet' type='text/css'>
16+
<script src="http://momentjs.com/downloads/moment.js" type="text/javascript"></script>
17+
<script src="/js/main.js" type="text/javascript"></script>
18+
</head>
19+
20+
21+
<!-- <a href="https://github.com/suavecode/SUAVE"><img style="position: absolute; z-index: 10; top: 0; right: 0; border: 0;" src="https://camo.githubusercontent.com/365986a132ccd6a44c23a9169022c0b5c890c387/68747470733a2f2f73332e616d617a6f6e6177732e636f6d2f6769746875622f726962626f6e732f666f726b6d655f72696768745f7265645f6161303030302e706e67" alt="Fork me on GitHub" data-canonical-src="https://s3.amazonaws.com/github/ribbons/forkme_right_red_aa0000.png"></a>-->
22+
<body>
23+
24+
<div class="page-content">
25+
<div class="wrapper">
26+
<aside class="left-nav">
27+
<div class="verticalLineL">
28+
&nbsp
29+
<a href="/" class="logo"><img src="/images/logo.svg" alt="SUAVE Code"><span>SUAVE</span></a>
30+
31+
<section>
32+
<h1 class="greetings"></h1>
33+
<p>A multi-fidelity conceptual design environment. Its purpose is to credibly produce conceptual-level design conclusions for future aircraft incorporating advanced technologies.</p>
34+
35+
</section>
36+
<nav class="main-nav">
37+
<ul>
38+
<li><a class="btn page-link " href="/">About</a></li>
39+
<li><a class="btn page-link " href="/download/">Download</a></li>
40+
<li><a class="btn page-link " href="/guides/">Guides</a></li>
41+
<li><a class="btn page-link active" href="/documentation/">Documentation</a></li>
42+
<li><a class="btn page-link " href="/develop/">Develop</a></li>
43+
<li><a class="btn page-link " href="/forum/">Forum</a></li>
44+
45+
</ul>
46+
</nav>
47+
48+
49+
<footer>
50+
<div class="social-media-list">
51+
<a class="social-media-link" href="https://github.com/suavecode/SUAVE">
52+
<span class="icon icon-github">
53+
<img src="/images/github.svg">
54+
</span>
55+
</a>
56+
57+
<a class="social-media-link" href="https://travis-ci.org/suavecode/SUAVE">
58+
<span class="icon icon-travis">
59+
<img src="/images/travis.svg">
60+
</span>
61+
</a>
62+
63+
64+
65+
</div>
66+
67+
<br>
68+
69+
<small>Copyright &copy; 2015 <br> Stanford Aerospace Design Lab <br> All rights reserved</small>
70+
</footer>
71+
72+
73+
</aside>
74+
<main class="main-content">
75+
<div class="page">
76+
77+
<div class="verticalLineR">
78+
79+
<header class="hero">
80+
<div class="valign">
81+
<h1 class="title">Documentation</h1>
82+
<p class="subtitle"> Everything you ever wanted to know to be SUAVE </p>
83+
</div>
84+
</header>
85+
86+
87+
<section class="content">
88+
<p> A direct link
89+
to the documentation for individual functions is <a href="http://suave.stanford.edu/doxygen">here</a>.</p>
90+
91+
<ul class="posts">
92+
93+
<li class="post">
94+
<div class="span-1 comment-count">
95+
</div>
96+
<div class="span-10">
97+
<a class="post-link" href="/guides/style.html">Code Style</a>
98+
<div class="span-10">
99+
<font size="2"> <a class="post-desc" href="/guides/style.html">Code style and basic development information</a>
100+
101+
</div>
102+
</li>
103+
104+
<li class="post">
105+
<div class="span-1 comment-count">
106+
</div>
107+
<div class="span-10">
108+
<a class="post-link" href="/guides/docs.html">Using the Documentation</a>
109+
<div class="span-10">
110+
<font size="2"> <a class="post-desc" href="/guides/docs.html">Reading (and writing) the documentation</a>
111+
112+
</div>
113+
</li>
114+
115+
<li class="post">
116+
<div class="span-1 comment-count">
117+
</div>
118+
<div class="span-10">
119+
<a class="post-link" href="/guides/mission.html">Mission Solver Structure</a>
120+
<div class="span-10">
121+
<font size="2"> <a class="post-desc" href="/guides/mission.html">Understanding the mission solver</a>
122+
123+
</div>
124+
</li>
125+
126+
<li class="post">
127+
<div class="span-1 comment-count">
128+
</div>
129+
<div class="span-10">
130+
<a class="post-link" href="/guides/energy_structure.html">Energy Networks</a>
131+
<div class="span-10">
132+
<font size="2"> <a class="post-desc" href="/guides/energy_structure.html">Understanding energy network structure</a>
133+
134+
</div>
135+
</li>
136+
137+
<li class="post">
138+
<div class="span-1 comment-count">
139+
</div>
140+
<div class="span-10">
141+
<a class="post-link" href="/guides/optimization.html">Optimization Structure</a>
142+
<div class="span-10">
143+
<font size="2"> <a class="post-desc" href="/guides/optimization.html">Understanding the optimization framework</a>
144+
145+
</div>
146+
</li>
147+
148+
</ul>
149+
150+
<p>&nbsp &nbsp &nbsp &nbsp &nbsp &nbsp </p>
151+
<p>&nbsp &nbsp &nbsp &nbsp &nbsp &nbsp </p>
152+
<p>&nbsp &nbsp &nbsp &nbsp &nbsp &nbsp </p>
153+
<p>&nbsp &nbsp &nbsp &nbsp &nbsp &nbsp </p>
154+
<p>&nbsp &nbsp &nbsp &nbsp &nbsp &nbsp </p>
155+
<p>&nbsp &nbsp &nbsp &nbsp &nbsp &nbsp </p>
156+
<p>&nbsp &nbsp &nbsp &nbsp &nbsp &nbsp </p>
157+
<p>&nbsp &nbsp &nbsp &nbsp &nbsp &nbsp </p>
158+
<p>&nbsp &nbsp &nbsp &nbsp &nbsp &nbsp </p>
159+
<p>&nbsp &nbsp &nbsp &nbsp &nbsp &nbsp </p>
160+
161+
</section>
162+
163+
</div>
164+
165+
166+
167+
</main>
168+
169+
</div>
170+
</div>
171+
172+
173+
<script>
174+
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
175+
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
176+
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
177+
})(window,document,'script','//www.google-analytics.com/analytics.js','ga');
178+
179+
ga('create', '', 'auto');
180+
ga('send', 'pageview');
181+
182+
</script>
183+
184+
<script type="text/javascript">
185+
/* * * CONFIGURATION VARIABLES * * */
186+
var disqus_shortname = '';
187+
188+
/* * * DON'T EDIT BELOW THIS LINE * * */
189+
(function () {
190+
var s = document.createElement('script'); s.async = true;
191+
s.type = 'text/javascript';
192+
s.src = '//' + disqus_shortname + '.disqus.com/count.js';
193+
(document.getElementsByTagName('HEAD')[0] || document.getElementsByTagName('BODY')[0]).appendChild(s);
194+
}());
195+
</script>
196+
197+
198+
</body>
199+
200+
</html>

‎_site/download/index.html

+38-31
Original file line numberDiff line numberDiff line change
@@ -25,25 +25,26 @@
2525
<div class="wrapper">
2626
<aside class="left-nav">
2727
<div class="verticalLineL">
28-
&nbsp
29-
<a href="/" class="logo"><img src="/images/logo.svg" alt="SUAVE Code"><span>SUAVE</span></a>
30-
31-
<section>
32-
<h1 class="greetings"></h1>
28+
&nbsp
29+
<a href="/" class="logo"><img src="/images/logo.svg" alt="SUAVE Code"><span>SUAVE</span></a>
30+
31+
<section>
32+
<h1 class="greetings"></h1>
3333
<p>A multi-fidelity conceptual design environment. Its purpose is to credibly produce conceptual-level design conclusions for future aircraft incorporating advanced technologies.</p>
34-
35-
</section>
36-
<nav class="main-nav">
37-
<ul>
38-
<li><a class="btn page-link " href="/">About</a></li>
39-
<li><a class="btn page-link active" href="/download/">Download</a></li>
40-
<li><a class="btn page-link " href="/guides/">Guides</a></li>
41-
<li><a class="btn page-link " href="/develop/">Develop</a></li>
42-
<li><a class="btn page-link " href="/forum/">Forum</a></li>
43-
44-
</ul>
45-
</nav>
46-
34+
35+
</section>
36+
<nav class="main-nav">
37+
<ul>
38+
<li><a class="btn page-link " href="/">About</a></li>
39+
<li><a class="btn page-link active" href="/download/">Download</a></li>
40+
<li><a class="btn page-link " href="/guides/">Guides</a></li>
41+
<li><a class="btn page-link " href="/documentation/">Documentation</a></li>
42+
<li><a class="btn page-link " href="/develop/">Develop</a></li>
43+
<li><a class="btn page-link " href="/forum/">Forum</a></li>
44+
45+
</ul>
46+
</nav>
47+
4748

4849
<footer>
4950
<div class="social-media-list">
@@ -78,7 +79,7 @@ <h1 class="greetings"></h1>
7879
<header class="hero">
7980
<div class="valign">
8081
<h1 class="title">Download</h1>
81-
<p class="subtitle">How to download and install</p>
82+
<p class="subtitle">How to download and install this fantastic tool</p>
8283
</div>
8384
</header>
8485

@@ -87,21 +88,27 @@ <h1 class="title">Download</h1>
8788

8889
<p>Jump in and design! Here are some helpful steps for downloading and installing the code. There are stable releases and beta releases. Also make sure to check out the license under which the code is available.</p>
8990

91+
<p><br /></p>
92+
9093
<h2 id="downloading">Downloading</h2>
9194

92-
<p>SUAVE comes released as a set of project folders ready for learning, research, and further development.</p>
95+
<p>SUAVE comes released as a set of project folders ready for learning and exploration. </p>
9396

94-
<p>Please take a few seconds to register with us by filling out the form on the pages linked below. Upon registration, you’ll be redirected to the appropriate distribution of the software. The information we collect is used <em>only</em> for usage statistics by the development team. You’ll only be contacted for notification of critical bug fixes and major releases. To get more involved in growing the community, definitely check out the <a href="/forum">forum</a>. Your support is greatly appreciated, it lets us build a better tool for everyone!</p>
97+
<p>Please take a few seconds to register with us by filling out the form on the pages linked below. Upon registration, you’ll be redirected to the appropriate distribution of the software. The information we collect is used <em>only</em> for usage statistics by the development team. You’ll only be contacted for notification of critical bug fixes and major releases. To get more involved in growing the community, definitely check out the <a href="/forum">forum</a>. Your support is greatly appreciated, it let’s us build a better tool for everyone!</p>
9598

9699
<h3 id="stable-release">Stable Release</h3>
97100
<p>Download the latest stable release of SUAVE: <br />
98-
<a href="/register/">SUAVE Version 0.9.0</a></p>
101+
<a href="/register/">SUAVE Version 1.0.0</a></p>
99102

100103
<h3 id="license">License</h3>
101104

102-
<p>We want SUAVE to grow with the community, so it’s available under a <br /><a href="https://www.gnu.org/licenses/old-licenses/lgpl-2.1.en.html">LGPL 2.1 License</a>.</p>
105+
<p>We want SUAVE to grow with the community, so it’s available under a <br /><a href="https://www.gnu.org/licenses/old-licenses/lgpl-2.1.en.html">LGPL 2.1 License</a>. </p>
106+
107+
<p>Please <script language="javascript" type="text/javascript">printEmailLink('suavecode-info', 'lists.stanford.edu','contact us');</script> if you are interested in re-publishing SUAVE source code as part of a commercial software. </p>
103108

104-
<p>Please <script language="javascript" type="text/javascript">printEmailLink('suavecode-info', 'lists.stanford.edu','contact us');</script> if you are interested in re-publishing SUAVE source code as part of a commercial software.</p>
109+
<h3 id="tutorials">Tutorials</h3>
110+
111+
<p>We also update our tutorials repository with every release to show new users some of the capabilities and how to use the code. The tutorial files can be found <a href="https://github.com/suavecode/Tutorials">here</a>. If you would like to use these, you may either follow the Github download instructions on the <a href="/develop">develop</a> page, but using <code class="highlighter-rouge">https://github.com/suavecode/Tutorials.git</code>, or you can download the files as a .zip using the “clone or download” button on the <a href="https://github.com/suavecode/Tutorials">Tutorials Github page</a>.</p>
105112

106113
<p><br /></p>
107114

@@ -119,22 +126,22 @@ <h3 id="simple-setup">Simple Setup</h3>
119126

120127
<ol>
121128
<li>Download and extract the release archive</li>
122-
<li>Open the directory <em>SUAVE_Project/Source/trunk</em></li>
129+
<li>Open the directory SUAVE/trunk</li>
123130
<li>Open a command prompt in that directory</li>
124131
<li>Run this command: <code class="highlighter-rouge">python setup.py install</code> <br />
125132
If you are on a linux or mac, you may need to run <br /> <code class="highlighter-rouge">sudo python setup.py install</code></li>
126133
<li>Change to any other folder, open a python shell, and test the new module with the command <code class="highlighter-rouge">import SUAVE</code></li>
127134
</ol>
128135

129-
<p>If all goes well, you are now able to import SUAVE into your python projects. Check out the <a href="/guides">guides</a> for examples on using the tutorials!</p>
136+
<p>If all goes well, you are now able to import SUAVE into your python projects. If you’ve downloaded the tutorials as well, check out the <a href="/guides">guides</a> for examples on using thems!</p>
130137

131138
<p>After trying out the guides you may find you want to make changes to the innards of the package to fit your problem, take a look at the <a href="/develop">develop</a> notes for how to set this up.</p>
132139

133-
<p>Have fun!</p>
140+
<p>Have fun! </p>
134141

135142
<p>If you had trouble installing or need to uninstall, there are some more tips ahead.</p>
136143

137-
<p><br /></p>
144+
<p><br /> </p>
138145

139146
<h3 id="dependencies">Dependencies</h3>
140147

@@ -177,7 +184,7 @@ <h3 id="dependencies">Dependencies</h3>
177184

178185
<h3 id="dealing-with-write-access">Dealing with Write Access</h3>
179186

180-
<p>You shouldn’t need this part of the guide unless you are unable to write-access the python site-packages directory. In that case, you can try these approaches to install SUAVE.</p>
187+
<p>You shouldn’t need this part of the guide, unless you are unable to write-access the python site-packages directory. In that case, you can try these approaches to install SUAVE.</p>
181188

182189
<h4 id="a-install-to-local-site-packages">A. Install to local site-packages</h4>
183190

@@ -232,7 +239,7 @@ <h3 id="additional-install-options">Additional Install Options</h3>
232239
<code class="highlighter-rouge">python setup.py install --help</code> <br />
233240
<code class="highlighter-rouge">python setup.py uninstall --help</code> <br />
234241
<code class="highlighter-rouge">python setup.py develop --help</code> <br />
235-
<code class="highlighter-rouge">python setup.py --help</code></p>
242+
<code class="highlighter-rouge">python setup.py --help</code> </p>
236243

237244
<p><br /></p>
238245

@@ -257,7 +264,7 @@ <h4 id="alternate-approach">Alternate Approach:</h4>
257264
Your site-packages folder is typically located in your python’s install directory, unless you manually created it. You can find it by using the following commands.<br />
258265
<code class="highlighter-rouge">$ python </code> <br />
259266
<code class="highlighter-rouge">&gt;&gt;&gt; import site</code> <br />
260-
<code class="highlighter-rouge">&gt;&gt;&gt; site.getsitepackages()</code></p>
267+
<code class="highlighter-rouge">&gt;&gt;&gt; site.getsitepackages()</code> </p>
261268
</li>
262269
<li>
263270
<p>Manually delete any file including the name “SUAVE”.<br />

0 commit comments

Comments
 (0)