Skip to content
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.

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

Made editorial changes usage doc. #2

Merged
merged 1 commit into from
Nov 30, 2011
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 2 additions & 2 deletions docs/conf.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@


# This file is autogenerated during plugin_quickstart and overwritten during
# plugin_makedist. DO NOT CHANGE IT if you plan to use plugin_makedist to package
# This file is autogenerated during plugin quickstart and overwritten during
# plugin makedist. DO NOT CHANGE IT if you plan to use plugin makedist to package
# distribution.

# -*- coding: utf-8 -*-
Expand Down
2 changes: 1 addition & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Contents:
.. toctree::
:maxdepth: 2

usage
usage.rst
srcdocs
pkgdocs

14 changes: 7 additions & 7 deletions docs/usage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,15 @@ Using the FLOPS Openmdao Wrapper
The FlopsWrapper component is a file-wrap of FLOPS, or Flight Optimization
System. This distribution includes the files you need to run FLOPS in
OpenMDAO. It does not include a source or binary distribution of FLOPS, which
you are assumed to already have installed in your local environment.
it is assumed you already have installed in your local environment.

The FlopsWrapper exposes practically every input variable that is editable in
the standard input file. It also provides a large selection of outputs that it
parses from the output file. Generally, the variables are grouped according to
their namelist in the intput file. Please see the source documentation for a
their namelist in the input file. Please see the source documentation for a
complete list of variables, with descriptions and values.

FlopsWrapper can be imported from flops_wrapper.py, which should reside in the
FlopsWrapper can be imported from ``flops_wrapper.py``, which should reside in the
site-packages directory of your activated Python environment once it is
installed.

Expand All @@ -29,18 +29,18 @@ into the openmdao component is to use the ``load_model`` method.
flops_comp.load_model('my_model.in')

FLOPS input files are Fortran namelists, and OpenMDAO is able to parse a
namelist file, and import that information into the existing variable
namelist file and import that information into the existing variable
structure of the FLOPS wrapper component.

The values can also be loaded manually by assigning each variable
individually. This is definitely the 'hard way', and will require a bit
more familiarity with the internals of the wrap. It is possible to
individually. This is definitely the "hard way" and will require you to be
familiar with the internals of the wrap. It is possible to
add and remove rerun, pconin, and segin groups this way as well.

When you create a new instance of FlopsWrapper, all of the variables are
initiated with the same default values that FLOPS uses.

If your local FLOPS install is not on your system path, you will need
If your local FLOPS install is not in your system path, you will need
to tell OpenMDAO where to find it as per the following example:

::
Expand Down