erdc/harmonica

API and CLI for tidal harmonics

#harmonica

API and CLI to get amplitude, phase, and speed of tidal harmonics from various tidal models (expandable, but currently TPXO 7.2, TPXO 8 and TPXO 9). Builds water surface time series utilizing pytides reconstruction and also provides access to pytides deconstruction.

harmonica's Issues

Failed to install

Traceback (most recent call last):
File "setup.py", line 8, in
raise RuntimeError(version_dict["error"])
RuntimeError: no suitable tags

add a tag for initial release

.

xarray auto_combine will be deprecated in version 0.13.

Hi,

The new version of xarray (0.13) will no longer use the auto_combine option.

C:\ProgramData\Anaconda3\lib\site-packages\xarray\backends\api.py:783: FutureWarning: In xarray version 0.13 `auto_combine` will be deprecated.
  coords=coords)
C:\ProgramData\Anaconda3\lib\site-packages\xarray\backends\api.py:783: FutureWarning: Also `open_mfdataset` will no longer accept a `concat_dim` argument.
To get equivalent behaviour from now on please use the new
`combine_nested` function instead (or the `combine='nested'` option to
`open_mfdataset`).The datasets supplied have global dimension coordinates. You may want
to use the new `combine_by_coords` function (or the
`combine='by_coords'` option to `open_mfdataset` to order the datasets
before concatenation. Alternatively, to continue concatenating based
on the order the datasets are supplied in in future, please use the
new `combine_nested` function (or the `combine='nested'` option to
open_mfdataset).
  coords=coords)

incorrect cli doc string for deconstruct

The cli doc string for harmonic deconstruct -h shows the lat/lon being included:

harmonica deconstruct 38.375789 -74.943915 -C M2 K1 -M tpxo8

Which is not accurate.

PEP 8 compliant

Become PEP 8 compliant

API catch for short signal

The catch for failing to converge on a solution (and the note to provide a longer signal) is not included in the API call. With the API, this will fail with only the scipy error Number of calls to function has reached maxfev and no other info. Something similar to what's below should be mimicked in the API

main_deconstruct.py Line 106:  
  
    try:
        tide = harmonica.Tide().deconstruct_tide(df[wl], df['datetimes'], cons=args.cons,
            n_period=args.num_periods, positive_ph=args.positive_phase)
    except RuntimeWarning as w:
        if 'Number of calls to function has reached maxfev' in str(w):
            print("\nThe solver failed to converge to a solution. Provide a longer signal.")
        else:
            print(str(w))
        print('\nFailed.\n')
        return

resource download fails in develop install

If you 'python setup.py develop' install harmonica into your environment, then an egg-link in site-packages is added to point to the code and therefore, the data directory for downloaded resources also.

After downloading a new resource, the file or extracted files are not written into the data directory. I surmise that the egg-link is breaking this. harmonica will fail when xarray attempts to read the non-existent data files.