API Documentation¶

Axis¶

`axis.LatitudeUnit`	Units setting out latitudes
`axis.LongitudeUnit`	Units setting out longitudes

`CellProperties`	Cell properties of the grid used for the interpolation.
`CoordinatesType`	Type of coordinates
`Field`	Abstract class defining a field where it is possible to calculate a speed
`FiniteLyapunovExponents`	Storing Lyapunov coefficients calculated
`FiniteLyapunovExponentsIntegration`	Handles the computation of Lyapunov Exponent
`Integration`	Handles the time integration
`IntegrationMode`	Mode of integration
`Iterator`	Definition of an iterator over a time period
`MapOfFiniteLyapunovExponents`	Handles a map of Finite Size or Time Lyapunov Exponents
`MapProperties`	Properties of a regular grid
`Path`	Handles the movement of a particle using the Runge-Kutta method.
`Position`	Define the position of N points Mᵢ = (xᵢ, yᵢ)
`Quintuplet`	Define the position of 5 points
`Reader`	Abstract class that defines a velocity reader fields.
`RungeKutta`	Fourth-order Runge-Kutta method
`Stencil`	Type of stencils known
`Triplet`	Define the position of 3 points
`UnitType`	Unit field

`debug`(message)	Display a debugging message
`set_verbose`(value)	Enable or disable verbose mode
`version`()	Return the version number

Provides support for units of physical quantities.

`field.Python`	Class to implement a velocity field in Python
`field.TimeSerie`	Time series of velocity field
`field.Vonkarman`	Vonkarman field

`reader.NetCDF`	Grid NetCDF CF reader.
`reader.Type`	Type of fields reader known