microhhpy 0.1.5

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

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