Home

Welcome to the GRBoondi Wiki pages!

The following set of documentation will aid in the familiarity of GRBoondi and will help you get started writing your own simulations!

Here are some suggestions:

• Is GRBoondi right for my project?

Please see the capabilities page for an outline of what GRBoondi is good for. Like its parent, GRChombo, GRBoondi is not meant to be a black box - you will need to understand, at least broadly, how GRBoondi works. That being said, this software was built to simplify many of the basic boiler-plate code required for setting up a simulation. Running a simulation should be as easy as plugging in the equations of motion, specifying the background, adding some parameters, and pressing go. Nonetheless, GRBoondi is versatile. You can inherit the matter and level classes and overwrite everything if you want, since almost all of the methods are virtual.

• How do I compile the examples?

Please see the Compiling GRBoondi page for instructions on how to compile your first example. You will certainly need pretty good familiarity with the command line and various make tools

• Where do I begin?

Check out the Getting Started page for instructions on how to begin your projects. See also Using GRBoondi for a comprehensive overview of how GRBoondi works and how to use it.

• I found a bug!! Where should I put it?

If you found a bug in the code, please feel free to submit an issue! Please provide as much detail as you can about the specific bug. Additionally, you can always send me an email.

• What if I don't want to simulate just Proca fields?

In this case, I would suggest you use another fixed background code. I highly recommend GRDzhadzha, which GRBoondi uses as one of its core dependencies.

Please feel free to submit issues or contact me directly if you have further questions, but please do your best to search the wiki first.