Skip to content

Commit

Permalink
Typo fixes and minor additions to documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
john-hen committed May 22, 2020
1 parent 5cd87f1 commit be9d0c8
Show file tree
Hide file tree
Showing 4 changed files with 10 additions and 6 deletions.
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
/dev/
/develop/
/docs/rendered/
/dist/
**/__pycache__
Expand Down
2 changes: 1 addition & 1 deletion docs/limitations.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ This library depends on the Python-to-Java bridge [JPype][jpype-repo].
It therefore inherits its limitation, in that only one Java virtual
machine can be managed within the same Python session, and thus only
one Comsol client. If several simulations are to be run in parallel,
distributed over independent process cores in an effort to achieve
distributed over independent processor cores in an effort to achieve
maximum speed-up of a parameter sweep, they have to be started as
separate Python (sub-)processes.

Expand Down
8 changes: 4 additions & 4 deletions mph/model.py
Original file line number Diff line number Diff line change
Expand Up @@ -151,12 +151,12 @@ def parameter(self, name, value=None, unit=None):
"""
Returns or sets the parameter of the given `name`.
If no value is given (the default `None` is passed), returns
If no `value` is given (the default `None` is passed), returns
the value of the named parameter. Otherwise sets it.
Numerical values are accepted, but will be converted to a
string. An optional `unit` may be specified, though it may
already be part of the value string, inside square brackets.
string. An optional `unit` may be specified, if it's not
already part of the value string, inside square brackets.
Values are always returned as strings, i.e. the expression as
entered in the user interface. That expression may include the
Expand Down Expand Up @@ -339,7 +339,7 @@ def evaluate(self, expression, unit=None, dataset=None,
sequence of indices, or by passing "first"/"last" to select
the very first/last index. If the dataset represents a
parameter sweep, the `outer` solution(s) can be selected by
index of sequence of indices.
index or sequence of indices.
Results are returned as NumPy arrays of whichever
dimensionality they may have. The expression may be a global
Expand Down
4 changes: 4 additions & 0 deletions mph/server.py
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,10 @@ class Server:
server.stop()
```
For this to work, make sure the Comsol server was started at least
once from the command line, so that you have had a chance to define
a user name and password.
For client―server connections across the network, the server's
host name or IP address has to be known by the client. This
information is *not* provided by this library. It has to either
Expand Down

0 comments on commit be9d0c8

Please sign in to comment.