Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
Merge pull request #33 from ocefpaf/notebooks
Fix README and add two notebook examples
  • Loading branch information
wesleybowman committed Apr 14, 2016
2 parents 0c612d5 + 688c05f commit 9f88220
Show file tree
Hide file tree
Showing 3 changed files with 521 additions and 10 deletions.
28 changes: 18 additions & 10 deletions README.md
Expand Up @@ -10,6 +10,7 @@ consult the Python function docstrings to see how to specify
parameters. Some functionality from the Matlab version is
not yet available.

```
% For more information see:
% Codiga, D.L., 2011. Unified Tidal Analysis and Prediction Using the
% UTide Matlab Functions. Technical Report 2011-01. Graduate School
Expand All @@ -19,7 +20,7 @@ not yet available.
%
% UTide v1p0 9/2011 d.codiga@gso.uri.edu
% http://www.po.gso.uri.edu/~codiga/utide/utide.htm

```

Installation
============
Expand All @@ -29,24 +30,29 @@ clone the git repository. In either case, change
your directory to the newly-created `utide` distribution
directory.

```
```shell
python setup.py install
```

or
```

```shell
python setup.py install --user
```
if you don't want a system-wide installation.

If you want to work on developing the package, then
```

```shell
python setup.py develop
```

will allow you to test without reinstalling after making
a modification.

Another option is to use
```

```shell
pip install .
```

Expand All @@ -55,13 +61,15 @@ you can install from the IOOS channel. See
https://github.com/ioos/conda-recipes/wiki.

The public functions can be imported using
```

```python
from utide import solve, reconstruct
```

To test and make sure that the package has been installed
and imported correctly, run:
```

```python
from utide.tests.test_solve import test_roundtrip
test_roundtrip()
```
Expand All @@ -70,16 +78,16 @@ If you have the pytest package installed, you can execute `py.test`
from within the source directory to run all tests.

A sample call would be
```

```python
from utide import solve

coef = solve(time, time_series_u, time_series_v,
lat=30,
cnstit='auto',
nodal=False,
trend=False,
method='ols',
conf_int='linear',
Rayleigh_min=095,)
Rayleigh_min=0.95,)
```

257 changes: 257 additions & 0 deletions notebooks/utide_real_data_example.ipynb

Large diffs are not rendered by default.

246 changes: 246 additions & 0 deletions notebooks/utide_uv_example.ipynb

Large diffs are not rendered by default.

0 comments on commit 9f88220

Please sign in to comment.