API Reference

Pryngles is a highly modular package divided into modules and data files.

In designing the package, we have followed the convention of creating, for each module, a corresponding Class with the same name as the module.

Thus, for instance, the module Spangler contains a general-purpose class spangler.Spangler that includes routines intended for sampling an astrophysical body surface.

Pryngles has two types of modules:

• General modules: These modules contain static classes, i.e. classes that cannot be instantiated and their methods work as regular functions.

  • Constants Module: Constants and other methods associated with them.

  • Science/Scatterer Module: Classes and methods involving useful scientific calculations.

• Core modules: These are the key modules in the package. They contain regular classes and perform the most specialized functions in the package.

  • Sampler Module: Module containing the classes and methods to generate samples of points.

  • Spangler Module: Classes and methods to spangle bodies.

  • Body Module: Classes and methods used to create and spangle astrophysical bodies.

  • Orbit Module: Main module to create hierarchical N-body system.

  • System Module: This is the most important module. It contains the classes and methods used to define a planetary system, spangle it, and calculate light-curves.