test and document period_op ... and makes sure API is convenient

CADWRDeltaModeling / vtools3

Pandas/xarray implementation of the most important functionality of vtools, emphasizing csv and netcdf as data sources.

https://cadwrdeltamodeling.github.io/vtools3/

Apache License 2.0

7 stars 1 forks source link

test and document period_op ... and makes sure API is convenient #5

Open water-e opened 4 years ago

water-e commented 4 years ago

period_op is a very simple wrapper around pandas that makes sure there is sufficient data. Default in pandas is to return an answer even if it includes half a tide cycle and this can produce ludicrous edge effects in tidal/partial data. Want to make sure the extra argument is convenient and document/test.