plot_snapshot_vxvv

eridanus_pbh.plot.plot_snapshot_vxvv(particles: Any, kind='cylindrical', timestamp: Union[Any, NoneType] = None, _format: str = 'csv', savefig: Union[str, NoneType] = None, close: bool = False)[source]

Plot Snapshot.

Parameters
particles: str or Particles

if str, uses amuse’s read_set_from_file to retrieve Particles

kind{‘cartesian’, ‘spherical’, ‘cylindrical’}
timestamp: Any

the timestamp of the snapshot added to the title if not None (default)

_format: str

format of file if particles is a file (str)

savefig: str or None, optional

save figure filename/path

close: bool

whether to close the figure

Returns
fig: matplotlib Figure or None

the figure, if close is False