Metadata-Version: 2.4
Name: imol
Version: 0.6.0
Summary: Estimate the inverse Monin-Obukhov length from bulk parameters
Project-URL: Homepage, https://github.com/equinor/imol
Project-URL: Repository, https://github.com/equinor/imol
Project-URL: Issues, https://github.com/equinor/imol/issues
Author-email: "Knut S. Seim" <knss@equinor.com>
License-Expression: MIT
License-File: LICENSE
Keywords: atmospheric-stability,boundary-layer,meteorology,monin-obukhov,offshore,wind-energy
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Science/Research
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Scientific/Engineering :: Atmospheric Science
Classifier: Topic :: Scientific/Engineering :: Physics
Requires-Python: >=3.10
Requires-Dist: numpy<3,>=2
Requires-Dist: pandas<3,>=2
Requires-Dist: scipy
Requires-Dist: xarray
Description-Content-Type: text/markdown

# imol

[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

A method for estimating the Monin-Obukhov length from bulk parameters has been developed following the documentation of AMOK (see documentation in the Fuga 
documentation folder).

The necessary observations are wind speed, $U$, at height $z_u$, air temperature, $T_a$, at height $z_a$, and sea surface temperature, $T_s$.
The observations of wind speed and air temperature should be made in the surface layer, and thus preferably lower than the typical hub height of a wind turbine, 10 m observations are ideal.

An [example notebook](https://github.com/equinor/imol/blob/main/examples/imol_example.ipynb) is available.

## Installation guide:
 Activate your virtual Python environment of choice and install [uv](https://docs.astral.sh/uv/getting-started/installation/).

Then install imol by running
```sh
git clone https://github.com/equinor/imol.git
cd imol
uv sync
```
To check the installation was successful, execute
```sh
uv run pytest tests
```
