swiftsimio package
- swiftsimio.validate_file(filename)[source]
Checks that the provided file is a SWIFT dataset.
- Parameters:
filename (str) – name of file we want to check is a dataset
- Returns:
if filename is a SWIFT dataset return True, otherwise raise exception
- Return type:
bool
- Raises:
KeyError – Crash if the file is not a SWIFT data file
- swiftsimio.mask(filename, spatial_only=True) SWIFTMask [source]
Sets up a masking object for you to use with the correct units and metadata available.
- Parameters:
filename (str) – SWIFT data file to read from
spatial_only (bool, optional) – Flag for only spatial masking, this is much faster but will not allow you to use masking on other variables (e.g. density). Defaults to True.
- Returns:
empty mask object set up with the correct units and metadata
- Return type:
Notes
If you are only planning on using this as a spatial mask, ensure that spatial_only remains true. If you require the use of the constrain_mask function, then you will need to use the (considerably more expensive, ~bytes per particle instead of ~bytes per cell spatial_only=False version).
- swiftsimio.load(filename, mask=None) SWIFTDataset [source]
Loads the SWIFT dataset at filename.
- Parameters:
filename (str) – SWIFT snapshot file to read
mask (SWIFTMask, optional) – mask to apply when reading dataset
- swiftsimio.load_statistics(filename) SWIFTStatisticsFile [source]
Loads a SWIFT statistics file (
SFR.txt
,energy.txt
).- Parameters:
filename (str) – SWIFT statistics file path
Subpackages
- swiftsimio.initial_conditions package
- swiftsimio.visualisation package
- Subpackages
- swiftsimio.visualisation.projection_backends package
- Submodules
- swiftsimio.visualisation.projection_backends.fast module
- swiftsimio.visualisation.projection_backends.gpu module
- swiftsimio.visualisation.projection_backends.histogram module
- swiftsimio.visualisation.projection_backends.kernels module
- swiftsimio.visualisation.projection_backends.reference module
- swiftsimio.visualisation.projection_backends.renormalised module
- swiftsimio.visualisation.projection_backends.subsampled module
- swiftsimio.visualisation.projection_backends.subsampled_extreme module
- Submodules
- swiftsimio.visualisation.tools package
- swiftsimio.visualisation.projection_backends package
- Submodules
- Subpackages
Submodules
- swiftsimio.accelerated module
- swiftsimio.conversions module
- swiftsimio.masks module
- swiftsimio.objects module
InvalidScaleFactor
cosmo_factor
cosmo_array
cosmo_array.comoving
cosmo_array.cosmo_factor
cosmo_array.compression
cosmo_array.astype()
cosmo_array.in_units()
cosmo_array.byteswap()
cosmo_array.compress()
cosmo_array.diagonal()
cosmo_array.flatten()
cosmo_array.newbyteorder()
cosmo_array.ravel()
cosmo_array.repeat()
cosmo_array.reshape()
cosmo_array.swapaxes()
cosmo_array.take()
cosmo_array.transpose()
cosmo_array.view()
cosmo_array.T
cosmo_array.ua
cosmo_array.unit_array
cosmo_array.convert_to_comoving()
cosmo_array.convert_to_physical()
cosmo_array.to_physical()
cosmo_array.to_comoving()
cosmo_array.compatible_with_comoving()
cosmo_array.compatible_with_physical()
cosmo_array.from_astropy()
cosmo_array.from_pint()
- swiftsimio.optional_packages module
- swiftsimio.reader module
MassTable
MappingTable
SWIFTUnits
SWIFTMetadata
SWIFTMetadata.header
SWIFTMetadata.filename
SWIFTMetadata.units
SWIFTMetadata.get_metadata()
SWIFTMetadata.get_named_column_metadata()
SWIFTMetadata.get_mapping_metadata()
SWIFTMetadata.postprocess_header()
SWIFTMetadata.load_particle_types()
SWIFTMetadata.extract_cosmology()
SWIFTMetadata.present_particle_types
SWIFTMetadata.present_particle_names
SWIFTMetadata.code_info
SWIFTMetadata.compiler_info
SWIFTMetadata.library_info
SWIFTMetadata.hydro_info
SWIFTMetadata.viscosity_info
SWIFTMetadata.diffusion_info
SWIFTParticleTypeMetadata
SWIFTParticleTypeMetadata.load_metadata()
SWIFTParticleTypeMetadata.load_field_names()
SWIFTParticleTypeMetadata.load_field_units()
SWIFTParticleTypeMetadata.load_field_descriptions()
SWIFTParticleTypeMetadata.load_field_compressions()
SWIFTParticleTypeMetadata.load_cosmology()
SWIFTParticleTypeMetadata.load_named_columns()
generate_getter()
generate_setter()
generate_deleter()
generate_dataset()
SWIFTDataset
- swiftsimio.statistics module
- swiftsimio.subset_writer module
- swiftsimio.swiftsnap module
- swiftsimio.units module
- swiftsimio.writer module