Visualisation

swiftsimio provides visualisation routines accelerated with the numba module. They work without this module, but we strongly recommend installing it for the best performance (1000x+ speedups). These are provided in the swiftismio.visualisation sub-modules.

The three built-in rendering types (described below) have the following common interface:

{render_func_name}_gas(
    data=data, # SWIFTsimIO dataset
    resolution=1024, # Resolution along one axis of the output image
    project="masses", # Variable to project, e.g. masses, temperatures, etc.
    parallel=False, # Construct the image in (thread) parallel?
    region=None, # None, or a list telling which region to render_func_name
    periodic=True, # Whether or not to apply periodic boundary conditions
)

The output of these functions comes with associated units and has the correct dimensions. There are lower-level APIs (also documented here) that provide additional functionality.