diff --git a/mousai/__init__.py b/mousai/__init__.py index e7acfb2..858d89d 100755 --- a/mousai/__init__.py +++ b/mousai/__init__.py @@ -19,7 +19,7 @@ __title__ = 'mousai' # version may have no more then numerical digits after decimal point. # 1.11 is actually a higher release than 1.2 (confusing) -__version__ = '0.2.4' +__version__ = '0.2.5' __author__ = 'Joseph C. Slater' __license__ = 'BSD-3-Clause' __copyright__ = 'Copyright 2017 Joseph C. Slater' diff --git a/mousai/har_bal.py b/mousai/har_bal.py index f8fc35e..9e5ea7b 100755 --- a/mousai/har_bal.py +++ b/mousai/har_bal.py @@ -64,13 +64,13 @@ def duff_osc(x, v, params): # params is a dictionary of parameters ---------- sdfunc : function For ``eqform='first_order'``, name of function that returns **column - vector** first derivative given `x`, omega and \*\*kwargs. This is + vector** first derivative given `x`, `omega` and \*\*kwargs. This is *NOT* a string. :math:`\dot{\mathbf{x}}=f(\mathbf{x},\omega)` For ``eqform='second_order'``, name of function that returns **column - vector** second derivative given `x`, `v`, omega and \*\*kwargs. This + vector** second derivative given `x`, `v`, `omega` and \*\*kwargs. This is *NOT* a string. :math:`\ddot{\mathbf{x}}=f(\mathbf{x},\mathbf{v},\omega)` @@ -79,28 +79,29 @@ def duff_osc(x, v, params): # params is a dictionary of parameters values representing the repeating solution. It is required that :math:`m = 1 + 2 num_{harmonics}`. (we will generalize allowable default values later.) - omega : float + omega : float assumed fundamental response frequency in radians per second. method : str, optional Name of optimization method to be used. num_harmonics : int, optional Number of harmonics to presume. The omega = 0 constant term is always presumed to exist. Minimum (and default) is 1. If num_harmonics*2+1 - exceeds the number of columns of x0 then x0 will be expanded, using + exceeds the number of columns of `x0` then `x0` will be expanded, using Fourier analaysis, to include additional harmonics with the starting presumption of zero values. num_variables : int, somewhat optional Number of states for a state space model, or number of generalized dispacements for a second order form. - If x0 is defined, num_variables is inferred. An error will result if - both x0 and num_variables are left out of the function call. - eqform : str - ``second_order`` or ``first_order``. + If `x0` is defined, num_variables is inferred. An error will result if + both `x0` and num_variables are left out of the function call. + `num_variables` must be defined if `x0` is not. + eqform : str, optional + ``second_order`` or ``first_order``. (second order is default) params : dict, optional Dictionary of parameters needed by sdfunc. realify : boolean, optional Force the returned results to be real. - other: any + other : any Other keyword arguments available to nonlinear solvers in `scipy.optimize.nonlin `_.