Skip to content

Commit

Permalink
Merge pull request #485 from kmarsteller/sphinx
Browse files Browse the repository at this point in the history
Sphinx
  • Loading branch information
Keith Marsteller committed Jan 10, 2018
2 parents ec30823 + dac61ba commit 493ce70
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 32 deletions.
36 changes: 9 additions & 27 deletions openmdao/core/system.py
Expand Up @@ -2114,7 +2114,6 @@ def add_response(self, name, type_, lower=None, upper=None, equals=None,
Mapping of this response to each design variable where simultaneous derivs will
be used. Each design variable entry is another dict keyed on color, and the values
in the color dict are tuples of the form (resp_idxs, color_idxs).
"""
# Name must be a string
if not isinstance(name, string_types):
Expand Down Expand Up @@ -2296,7 +2295,7 @@ def add_objective(self, name, ref=None, ref0=None, index=None,
ref0 : float or ndarray, optional
Value of response variable that scales to 0.0 in the driver.
index : int, optional
If variable is an array, this indicates which entriy is of
If variable is an array, this indicates which entry is of
interest for this particular response. This may be a positive
or negative integer.
adder : float or ndarray, optional
Expand Down Expand Up @@ -2533,9 +2532,9 @@ def list_inputs(self,
When True, human readable output shows variables in hierarchical format.
print_arrays : bool, optional
When False, in the columnar display, just display norm of any ndarrays with size > 1.
The norm is surrounded by vertical bars to indicate that it is a norm.
The norm is surrounded by vertical bars to indicate that it is a norm.
When True, also display full values of the ndarray below the row. Format is affected
by the values set with numpy.set_printoptions
by the values set with numpy.set_printoptions
Default is False.
out_stream : 'stdout', 'stderr' or file-like
Where to send human readable output. Default is 'stdout'.
Expand Down Expand Up @@ -2588,43 +2587,32 @@ def list_outputs(self,
----------
explicit : bool, optional
include outputs from explicit components. Default is True.
implicit : bool, optional
include outputs from implicit components. Default is True.
values : bool, optional
When True, display/return output values. Default is True.
residuals : bool, optional
When True, display/return residual values. Default is False.
residuals_tol : float, optional
If set, limits the output of list_outputs to only variables where
the norm of the resids array is greater than the given 'residuals_tol'.
Default is None.
units : bool, optional
When True, display/return units. Default is False.
shape : bool, optional
When True, display/return the shape of the value. Default is False.
bounds : bool, optional
When True, display/return bounds (lower and upper). Default is False.
scaling : bool, optional
When True, display/return scaling (ref, ref0, and res_ref). Default is False.
hierarchical : bool, optional
When True, human readable output shows variables in hierarchical format.
print_arrays : bool, optional
When False, in the columnar display, just display norm of any ndarrays with size > 1.
The norm is surrounded by vertical bars to indicate that it is a norm.
The norm is surrounded by vertical bars to indicate that it is a norm.
When True, also display full values of the ndarray below the row. Format is affected
by the values set with numpy.set_printoptions
by the values set with numpy.set_printoptions
Default is False.
out_stream : 'stdout', 'stderr' or file-like
Where to send human readable output. Default is 'stdout'.
Set to None to suppress.
Expand Down Expand Up @@ -2698,27 +2686,21 @@ def _write_outputs(self, in_or_out, comp_type, outputs, hierarchical, print_arra
----------
in_or_out : str, 'input' or 'output'
indicates whether the values passed in are from inputs or output variables.
comp_type : str, 'Explicit' or 'Implicit'
the type of component with the output values.
outputs : list
list of (name, dict of vals and metadata) tuples.
hierarchical : bool
When True, human readable output shows variables in hierarchical format.
print_arrays : bool
When False, in the columnar display, just display norm of any ndarrays with size > 1.
The norm is surrounded by vertical bars to indicate that it is a norm.
The norm is surrounded by vertical bars to indicate that it is a norm.
When True, also display full values of the ndarray below the row. Format is affected
by the values set with numpy.set_printoptions
by the values set with numpy.set_printoptions
Default is False.
out_stream : 'stdout', 'stderr' or file-like
Where to send human readable output. Default is 'stdout'.
Set to None to suppress.
"""
if out_stream is None:
return
Expand Down Expand Up @@ -2910,9 +2892,9 @@ def _write_outputs_rows(self, logger, row, column_names, dict_of_outputs, print_
print_arrays : bool
When False, in the columnar display, just display norm of any ndarrays with size > 1.
The norm is surrounded by vertical bars to indicate that it is a norm.
The norm is surrounded by vertical bars to indicate that it is a norm.
When True, also display full values of the ndarray below the row. Format is affected
by the values set with numpy.set_printoptions
by the values set with numpy.set_printoptions
Default is False.
"""
Expand Down
5 changes: 0 additions & 5 deletions openmdao/docs/examples/keplers_equation/keplers_equation.rst
Expand Up @@ -40,13 +40,8 @@ equation, using :math:`M` as the initial guess for :math:`E` is a good starting
In summary, the recipe for solving Kepler's equation is as follows:

- Define a problem with a `Group` as its model.
<<<<<<< HEAD
- To that Group, add components which provide, :math:`M`, :math:`e`, and the left-hand side of Kepler's equation.
- Add a linear and nonlinear solver to the Group, since the default solvers do not iterate.
=======
- To that Group, add components which provide, `M`, `e`, and the left-hand-side of Kepler's equation.
- Add a linear and nonlinear solver to the Group, since the default solver's do not iterate.
>>>>>>> master
- Setup the problem, set values for the inputs, and run the model.

.. embed-test::
Expand Down

0 comments on commit 493ce70

Please sign in to comment.