Metadata-Version: 2.4
Name: microhhpy
Version: 0.1.14
Summary: Python package with utility functions for working with MicroHH LES/DNS.
Author-email: Bart van Stratum <bart@cloudysky.cc>
License-Expression: GPL-3.0-or-later
Project-URL: Homepage, https://github.com/microhh/microhhpy
Keywords: large eddy simulation,LES,direct numerical simulation,DNS,computational fluid dynamics,CFD,meteorology,turbulence
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: POSIX :: Linux
Classifier: Operating System :: MacOS
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy
Requires-Dist: matplotlib
Requires-Dist: pyproj
Requires-Dist: colorlog
Requires-Dist: numba
Requires-Dist: cartopy
Requires-Dist: xarray
Requires-Dist: netCDF4
Requires-Dist: scipy
Requires-Dist: rioxarray
Requires-Dist: ls2d
Dynamic: license-file

# MicroHHpy

---
[![PyPi Badge](https://img.shields.io/pypi/v/microhhpy.svg?colorB=blue)](https://pypi.python.org/pypi/microhhpy/)
---

### Description

Python package with utility functions for working with MicroHH LES/DNS.

The main purpose of `microhhpy` is to simplify complex workflows and case setups, such as setting up nested simulations with open boundary conditions. Basic scripts for handling MicroHH input and output are still available in `microhh/python/microhh_tools.py` and other scripts like `cross_to_nc.py`.

Most of the functionality of `microhhpy` is demonstrated in the notebooks located in `microhhpy/examples`.

> [!IMPORTANT]  
> Like `microhh` itself, this Python package has only been tested in Unix environments.

### Usage

The recommended way to install `microhhpy` is via PyPI:

    pip install microhhpy

For development, you can clone the repository and make `microhhpy` available in one of three ways:

1. Editable install with `pip`. Clone the source code from Github, and install it (preferably in a development virtual environment) using:

       pip install -e /path/to/microhhpy

2. Without `pip`, you can expose `microhhpy` by adding it to your `PYTHONPATH`:

       export PYTHONPATH="${PYTHONPATH}:/path/to/microhhpy"

3. Or append the path directly in your Python script before importing:

       import sys
       sys.path.append('/path/to/microhhpy')

Once set up, you can import `microhhpy` modules, for example:

    from microhhpy.spatial import Domain
    from microhhpy.spatial import Projection
