API#
Note
Even though the performance critical sections of choreo are coded in Cython, the actual underlying C types only appear in this API documentation as part of function prototypes. The rest of the API documentation uses Python types as expected from a user interacting with the code. This follows Cython’s automatic type conversions and uses numpy.ndarray in lieu of Cython typed memoryviews.
The following modules classes are concerned:
choreo.scipy_plus.ODE
choreo#
Systems of interacting point masses#
This class defines a N-body system |
Defining Symmetries#
This class defines the symmetries in a N-body system. |
Entrypoints#
choreo_CLI_search#
Searches periodic solutions to the N-body problem as defined in choreo_GUI
usage: choreo_CLI_search [-h] [-f]
- -h, --help#
show this help message and exit
- -f <workspace_folder>, --foldername <workspace_folder>#
Workspace folder as defined in the GUI. Defaults to the current directory.
choreo_GUI#
Launches choreo GUI
usage: choreo_GUI [-h] [-f]
- -h, --help#
show this help message and exit
- -f <gallery_root>, --foldername <gallery_root>#
Gallery root.