OpenBT Python package

Todo

Matt to write high-level description and motivate breakdown of documents presented here. License, copyright, responsibilities of user, etc.

The heart of OpenBT is a set of C++ tools that can be used directly via the command line or indirectly through the openbt Python package, which wraps them. Typically these tools are built with an implementation of the Message Passing Interface (MPI), such as Open MPI or MPICH, to enable distributed parallelization of computations. In particular, the Python wrapper package is always built with MPI support.

The OpenBT software and its distribution scheme have been developed to allow users to use OpenBT with the MPI installation of their choice. For instance, it can be built with MPI installed on a laptop using the system’s package manager or with MPI installations on leadership class platforms and clusters that were installed by experts and optimized for their specific platform.

This repository is being established by merging the contents of the original OpenBT repository with the OpenBTMixing repository, which was based off of the former. It, therefore, will supersede those two repositories, which will be frozen.

This repository and its contents are being established and developed as part of BAND framework.

Note

While an R wrapper does exist for the original OpenBT and OpenBTMixing repositories, that functionality has not yet been included in this new, combined repository (Issue 35).