From ba2a85d9d5ccc33aa32c69c162aa47fda0272d07 Mon Sep 17 00:00:00 2001 From: Paulette Ziegfeld Date: Thu, 17 Nov 2011 13:54:35 -0500 Subject: [PATCH] Made editorial changes usage doc. --- docs/conf.py | 4 ++-- docs/index.rst | 2 +- docs/usage.rst | 14 +++++++------- 3 files changed, 10 insertions(+), 10 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index af36b81..1ac26de 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -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 -*- diff --git a/docs/index.rst b/docs/index.rst index d7a0ce5..2ee410f 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -9,7 +9,7 @@ Contents: .. toctree:: :maxdepth: 2 - usage + usage.rst srcdocs pkgdocs diff --git a/docs/usage.rst b/docs/usage.rst index 70c6c16..1e70bcb 100644 --- a/docs/usage.rst +++ b/docs/usage.rst @@ -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. @@ -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: ::