Installation

The versions of the dependencies for BrahMap are quite flexible. If you intend to use BrahMap alongside other packages (like litebird_sim), we recommend installing BrahMap after you have installed those packages in the same environment.

BrahMap requires an MPI library to compile the C++ extensions. By default, it uses the mpicxx compiler wrapper for this task. However, you can override this default by setting the MPICXX environment variable to your preferred compiler. To install BrahMap, follow these steps:

# Clone the repository
git clone https://github.com/anand-avinash/BrahMap.git

# Enter the directory
cd BrahMap

# Set the compiler you want to use (optional)
export MPICXX=mpiicpc

# Install the package
pip install .

# Alternatively, perform an editable installation for development purposes
# followed by `pre-commit` install
pip install -e .
pre-commit install

Note

BrahMap uses Setuptools to build the C++ extensions. By default, it generates the compilation command by gathering various environment variables. You can customize the compilation flags used during the installation by setting the CXXFLAGS, CPPFLAGS, and LDFLAGS environment variables.