fardal_stream

gala.dynamics.mockstream.fardal_stream(hamiltonian, prog_orbit, prog_mass, release_every=1, Integrator=<class 'gala.integrate.pyintegrators.dopri853.DOPRI853Integrator'>, Integrator_kwargs={}, snapshot_filename=None, seed=None, output_every=1)

Generate a mock stellar stream in the specified potential with a progenitor system that ends up at the specified position.

This uses the prescription from Fardal et al. (2015).

Parameters:

hamiltonian : Hamiltonian

The system Hamiltonian.

prog_orbit : Orbit

The orbit of the progenitor system.

prog_mass : numeric, array_like

A single mass or an array of masses if the progenitor mass evolves with time.

release_every : int (optional)

Release particles at the Lagrange points every X timesteps.

Integrator : Integrator (optional)

Integrator to use.

Integrator_kwargs : dict (optional)

Any extra keyword argumets to pass to the integrator function.

snapshot_filename : str (optional)

Filename to save all incremental snapshots of particle positions and velocities. Warning: this can make very large files if you are not careful!

output_every : int (optional)

If outputing snapshots (i.e., if snapshot_filename is specified), this controls how often to output a snapshot.

seed : int (optional)

A random number seed for initializing the particle positions.

Returns:

stream : PhaseSpacePosition