Cuboid Remap

This is a python package which implements an algorithm to remap cubical domains with periodic boundary conditons (PBCs) to cuboid domains.

Description

The original implementation of this alogrithm by Jordan Carlson and Martin White is available here and presented in arxiv:1003.3178. If you use this code, you should cite that original publication.

Requirements

In order to use the functions in this package, you will need the following Python packages installed:

• numpy

Installation

Place this directory in your PYTHONPATH. The various functions can then be imported as, e.g.:

from cuboid_remap import remap

You can run the testing suite for this package using the pytest framework by executing the following command in the package directory:

pytest

contact: duncanc@andrew.cmu.edu