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 with specified shape and dtype attributes when possible in lieu of Cython typed memoryviews as present in the code.

The following modules classes are concerned:

choreo#

Systems of interacting point masses#

NBodySyst

This class defines a N-body system

Defining symmetries#

ActionSym

This class defines the symmetries in a N-body system.

Numerical tools on segment#

`segm.quad.QuadTable`	Numerical integration and approximation.
`segm.multiprec_tables.ComputeQuadrature`	Computes a `choreo.segm.quad.QuadTable`
`segm.quad.EvalOnNodes`	Evaluates a function on quadrature nodes of an interval.
`segm.quad.IntegrateOnSegment`	Computes an approximation of the integral of a function on a segment.
`segm.quad.InterpolateOnSegment`	Interpolates a function given its value on quadrature nodes of an interval.
`segm.ODE.ExplicitSymplecticRKTable`	Butcher Tables for explicit symplectic Runge-Kutta methods
`segm.ODE.ExplicitSymplecticIVP`	Explicit symplectic integration of a partitionned initial value problem.
`segm.ODE.ImplicitRKTable`	Butcher Tables for fully implicit Runge-Kutta methods
`segm.multiprec_tables.ComputeImplicitRKTable`	Computes a `choreo.segm.ODE.ImplicitRKTable`
`segm.ODE.ImplicitSymplecticIVP`	Implicit symplectic integration of a partitionned initial value problem.

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 the GUI server.

Access the GUI by typing http://127.0.0.1:8000 in your favorite internet browser after launching the server.

usage: choreo_GUI [-h] [-f]

-h, --help#: show this help message and exit

-f <gallery_root>, --foldername <gallery_root>#: Gallery root.