.. _core.flowChar:

ocmw.core.flowChar module
=========================

A preprocessor for extracting flow characterisaton information from a timeseries of tidal flow 
data extracted from either modelled or measured data at a specific height in the water column.

The timeseries data are generated by the ocmw extract tools.

.. autosummary::
	:nosignatures:
	
	~ocmw.core.flowChar.preprocess_ts
	~ocmw.core.flowChar.tidal_flow_peak_directions
	~ocmw.core.flowChar.id_tidal_flow_peaks
	~ocmw.core.flowChar.get_flood_ebb_indices
	~ocmw.core.flowChar.flow_acceleration
	~ocmw.core.flowChar.streamwise_flow

There are separate functions for calculating TEC power based on either the hub-height velocities, 
rotor-average velocities, or power-weighted rotor average velocites.

.. autosummary::
	:nosignatures:

	~ocmw.core.flowChar.tec_power
	~ocmw.core.flowChar.rotor_average_vel
	~ocmw.core.flowChar.pwra_vel
	~ocmw.core.flowChar.chord_area
	~ocmw.core.flowChar.moving_average
	~ocmw.core.flowChar.movmean
	

.. automodule:: ocmw.core.flowChar
   :members:
   :undoc-members:
   :show-inheritance: