Introduction

Vtools is a package to perform time-aligned operations on time series, as well as some specialty analyses encountered in hydrology and hydrodynamic work and modeling. The goal of vtools is to fill in around tools like pandas and netcdf4-python and to provide a bridge between netcdf and the legacy format HEC-DSS from the Hydrologic Engineering Center of the Army Corps of Engineers.

Documentation

Learning vtools is something you can mostly learn by example, so most of the topics below are coding examples with a few explanations. There is some traditional api documentation as well.

• Getting and Installing vtools
  • Prerequisites
  • VTools Install
  • PyDSS
• Time and time interval concepts
  • Datetime and ticks
  • Time intervals
  • Datetime and time interval arithmetic
  • Time sequence
  • Time windows
• Time series class
  • Time series class
  • Regular vs irregular
  • Creating time series
  • Properties: metadata about the series
  • Timestamp conventions for period aggregated (e.g. ave) data
  • Indexing, slicing
  • Shifting series and centering period averaged data
  • Iterating through time
  • Time series arithmetic
• Functions
  • Python Imports
  • Interpolation
  • Low Pass Filtering (noise, tidal, spring-neap)
  • Resampling and decimation
  • Ufuncs on time series
  • Period ops
  • Shifting
  • Merging
• Getting data in and out of vtools
  • Data stores in vtools
  • Loading and storing data using simple utility functions
  • Catalogs

Indices and tables

• Index
• Module Index
• Search Page