Skip to content

Commit

Permalink
Fix minor typos in Python doc
Browse files Browse the repository at this point in the history
  • Loading branch information
Kiri Choi committed Oct 15, 2015
1 parent 100460b commit e89b7c6
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 23 deletions.
14 changes: 7 additions & 7 deletions wrappers/Python/doc/mod_roadrunner/cls_Config.rst
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ Configuration Functions

Read all of the values from a configuration file at the given path. This overrides any previously
stored configuration. This allows users to have any number of configuration files and load them
at any time. Say someone had to use Windows, and they had a file in thier C: drive, this would be
at any time. Say someone had to use Windows, and they had a file in their C: drive, this would be
loaded via::
Config.readConfigFile("C:/my_config_file.txt")
Expand Down Expand Up @@ -104,10 +104,10 @@ here. The variable type of the parameter is listed after the key name.
with this flag enabled can not be compared index wise to results
generated otherwise.

Moiety conservation is only compatable with simple models which do NOT have any events or rules
Moiety conservation is only compatible with simple models which do NOT have any events or rules
which define or alter any floating species, and which have simple constant stoichiometries.

Moiety conservation may cause unexpected results, be aware of what it is before enableing.
Moiety conservation may cause unexpected results, be aware of what it is before enabling.

Not recommended for time series simulations.

Expand Down Expand Up @@ -158,7 +158,7 @@ here. The variable type of the parameter is listed after the key name.
:annotation: bool

GVN - This pass performs global value numbering and redundant load
elimination cotemporaneously.
elimination contemporaneously.



Expand Down Expand Up @@ -240,13 +240,13 @@ here. The variable type of the parameter is listed after the key name.
This is intended to be used in combination with the
IntegratorListener. It this option is set, and there is a
IntegratorListener set, RoadRunner::integrate will run the
integrator in a series of internal steps, and the listner
integrator in a series of internal steps, and the listener
will by notified at each step.

Highly Experimental!!!


.. attribute:: Config.ROADRUNNER_DISABLE_PYTHON_DYNAMIC_PROPERTIES,
.. attribute:: Config.ROADRUNNER_DISABLE_PYTHON_DYNAMIC_PROPERTIES
:module: RoadRunner
:annotation: int

Expand All @@ -257,7 +257,7 @@ here. The variable type of the parameter is listed after the key name.
can be disabled here.


.. attribute:: Config.ROADRUNNER_DISABLE_WARNINGS,
.. attribute:: Config.ROADRUNNER_DISABLE_WARNINGS
:module: RoadRunner
:annotation: int

Expand Down
18 changes: 2 additions & 16 deletions wrappers/Python/doc/mod_roadrunner/cls_ExecutableModel.rst
Original file line number Diff line number Diff line change
Expand Up @@ -289,14 +289,7 @@ Boundary Species

:param numpy.ndarray index: (optional) an index array indicating which items to return.
:returns: an array of the boundary species amounts.
:rtype: numpy.ndarray.

given by the order of Ids returned by getBoundarySpeciesIds()

:param numpy.ndarray index: (optional) an index array indicating which items to return.
:returns: an array of the boundary species amounts.
:rtype: numpy.ndarray.

:rtype: numpy.ndarray

>>> r.model.getBoundarySpeciesAmounts()
array([ 15., 0.])
Expand All @@ -310,14 +303,7 @@ Boundary Species

:param numpy.ndarray index: (optional) an index array indicating which items to return.
:returns: an array of the boundary species concentrations.
:rtype: numpy.ndarray.

given by the order of Ids returned by getBoundarySpeciesIds()

:param numpy.ndarray index: (optional) an index array indicating which items to return.
:returns: an array of the boundary species concentrations.
:rtype: numpy.ndarray.

:rtype: numpy.ndarray

>>> r.getBoundarySpeciesConcentrations()
array([ 0.5, 0.])
Expand Down

0 comments on commit e89b7c6

Please sign in to comment.