muGrid 0.0.0

MPI-parallel regular grids

µGrid

µGrid is a library for discrete representation of fields on structured grids. A field is a physical quantity that varies in space. µGrid makes it easy to implement algorithms that operate on fields, such as solving partial differential equations. It supports parallelization using domain decomposition implemented using the Message Passing Interface (MPI).

µGrid is written in C++ and currently has language bindings for Python.

This README contains only a small quick start guide. Please refer to the full documentation or the DeepWiki LLM-generated documentation for more help.

Quick start

To install µGrid, run

pip install muGrid

Note that on most platforms this will install a binary wheel, that was compiled with a minimal configuration. To compile for your specific platform use

pip install -v --no-binary muGrid muGrid

which will compile the code. µGrid will autodetect MPI. For I/O, it will try to use Unidata NetCDF for serial builds and PnetCDF for MPI-parallel builds. Monitor output to see which of these options were automatically detected.

Funding

This development has received funding from the Swiss National Science Foundation within an Ambizione Project and by the European Research Council within Starting Grant 757343.