Skip to content

Commit

Permalink
Edits to README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
jreniel committed Jan 25, 2020
1 parent 319469a commit af62822
Showing 1 changed file with 7 additions and 2 deletions.
9 changes: 7 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,6 @@ pip install -e .
### Usage examples:
---
#### Using the CLI
---
##### Example 1: Full domain hgrid plot from the terminal.
``` bash
plot_mesh /path/to/hgrid.gr3 --plot-boundaries --plot-elements
Expand All @@ -36,7 +35,13 @@ plot_mesh /path/to/hgrid.gr3 --plot-boundaries --plot-elements

---
#### Using the Library
---
Hint: You can test the library functions from the command line (without having to write a .py file) by using `python -c` and wrapping the commands between a pair of quotes, for example:
```bash
python -c "
from pyschism.mesh import Hgrid
print(Hgrid.open('/path/to/hgrid.gr3'))
"
```
##### Example 1: Full domain Hgrid plot:
``` python
from pyschism.mesh import Hgrid
Expand Down

0 comments on commit af62822

Please sign in to comment.