Documentation

Documentation on the modules of the Reaction Plane Fit package are available below. For getting started, take a look at reaction_plane_fit.example.run_fit().

• base module
• functions module
• fit module
• three_orientations module
• example module

Some additional helpful links:

• Index
• Module Index
• Search Page

For any code contributions, please be certain to document:

• New functions, arguments, and classes.
• New attributes of classes.

All of the above can be documented in the source, with the exception of adding new modules to the docs. The new modules must be added in the docs/api folder.