Documentation Guidelines - N-BodyShop/changa GitHub Wiki

Where to Find Documentation on ChaNGa

All documentation for the public release of ChaNGa can be found in the wiki you are currently viewing.

There is also automatically generated doxygen code documentation available here. Be aware that this documentation is very low-level, and not particularly user friendly. It will be mostly of use for you if you are developing for ChaNGa.

Contributing to ChaNGa Documentation

As you use ChaNGa on different machines, you will find each machine may require a slightly different set of build & run parameters to get optimal performance. You can add this information to this wiki in the Machine Specific Build Instructions

You may also be working on new features for ChaNGa. If you contribute these features back to the public release, please consider adding documentation for them here.