Skip to content

Commit

Permalink
Update README.md (#47)
Browse files Browse the repository at this point in the history
Make it more clear how the bindings can be used:

* Introduce section "Usage" and put usage examples there.
* Add a reference to file `precice.pyx` which contains a nicely commented overview over the available functions.
* Shed some light on the differences between `precice` and `pyprecice`.
  • Loading branch information
ajaust authored Apr 30, 2020
1 parent 7253dbc commit e985f78
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -134,9 +134,11 @@ $ python3 -c "import precice"
$ python3 setup.py test
```

**NOTE:**
# Usage

- For an example of how `pyprecice` can be used, refer to the [1D elastic tube example](https://github.com/precice/precice/wiki/1D-elastic-tube-using-the-Python-API).
You can find the documentation of the implemented interface in the file `precice.pyx`. For an example of how `pyprecice` can be used please refer to the [1D elastic tube example](https://github.com/precice/precice/wiki/1D-elastic-tube-using-the-Python-API).

**Note** The python package that is installed is called `pyprecice`. It provides the python module `precice` that can be use in your code via `import precice`, for example.

# Troubleshooting & miscellaneous

Expand Down

0 comments on commit e985f78

Please sign in to comment.