Metadata-Version: 2.1
Name: pylake
Version: 0.0.10
Summary: pylake
Home-page: https://github.com/hugocruzz/pylake
Author: Hugo Cruz
Author-email: <huggcruzz@gmail.com>
License: MIT
Keywords: python,pylake,Lake analyzer,environmental data,Physical properties
Description-Content-Type: text/markdown

# PyLake

This work present methods used to compute meaningful physical properties in aquatic sciences.

Multi-dimensional array (time and depth) are compatible.

Algorithms and documentation are inspired by LakeAnalyzer in R (https://github.com/GLEON/rLakeAnalyzer)

Implemented methods:
* Thermocline
* Mixed layer
* Metalimnion extent (top metalimnion and bottom metalimnion)
* Wedderburn Number
* Schmidt stability
* internal energy
* Seiche periode
* Lake Number
* Brunt-Vaisala frequency
* Average layer temperature

Future updates:
* Data check and comparison with other sources
* Xarray based algorithms for spatial data compatibility
* Thermocline uses a smoothing algorithm (savgol filter) to correct the variability in vertical resolution. This method is temporary and need to be replaced.
* Mixed layer interpolation need to be optimized, set as parameter for now

## Installation

`pip install pylake`

## Usage
```python
import pylake
import numpy as np

temp = np.array([14.3,14,12.1,10,9.7,9.5])
depth = np.array([1,2,3,4,5,6])
hypolimnion, epilimnion = pylake.metalimnion(temp, depth)
```
