rubix package

Subpackages

• rubix.core package
  • Submodules
  • rubix.core.cosmology module
    • get_cosmology()
  • rubix.core.data module
    • Galaxy
    • GasData
      • GasData.metals
    • RubixData
    • StarsData
    • convert_to_rubix()
    • get_reshape_data()
    • get_rubix_data()
    • prepare_input()
    • process_attributes()
    • reshape_array()
  • rubix.core.ifu module
  • rubix.core.lsf module
    • get_convolve_lsf()
  • rubix.core.noise module
    • get_apply_noise()
  • rubix.core.pipeline module
  • rubix.core.psf module
    • get_convolve_psf()
  • rubix.core.rotation module
    • get_galaxy_rotation()
  • rubix.core.ssp module
  • rubix.core.telescope module
    • get_filter_particles()
    • get_spatial_bin_edges()
    • get_spaxel_assignment()
    • get_telescope()
  • Module contents
• rubix.cosmology package
  • Submodules
  • rubix.cosmology.base module
    • BaseCosmology
      • BaseCosmology.age_at_z()
      • BaseCosmology.age_at_z0()
      • BaseCosmology.angular_diameter_distance_to_z()
      • BaseCosmology.angular_scale()
      • BaseCosmology.comoving_distance_to_z()
      • BaseCosmology.distance_modulus_to_z()
      • BaseCosmology.lookback_to_z()
      • BaseCosmology.luminosity_distance_to_z()
      • BaseCosmology.scale_factor_to_redshift()
  • rubix.cosmology.utils module
    • trapz()
  • Module contents
• rubix.galaxy package
  • Subpackages
    • rubix.galaxy.input_handler package
      • Submodules
      • rubix.galaxy.input_handler.base module
        • BaseHandler
        • create_rubix_galaxy()
      • rubix.galaxy.input_handler.factory module
      • rubix.galaxy.input_handler.illustris module
        • IllustrisHandler
      • Module contents
        • BaseHandler
        • IllustrisAPI
        • get_input_handler()
  • Submodules
  • rubix.galaxy.alignment module
    • apply_init_rotation()
    • apply_rotation()
    • center_particles()
    • euler_rotation_matrix()
    • moment_of_inertia_tensor()
    • rotate_galaxy()
    • rotation_matrix_from_inertia_tensor()
  • Module contents
• rubix.pipeline package
  • Submodules
  • rubix.pipeline.abstract_pipeline module
    • AbstractPipeline
      • AbstractPipeline.assemble()
      • AbstractPipeline.compile_element()
      • AbstractPipeline.compile_expression()
      • AbstractPipeline.get_jaxpr()
      • AbstractPipeline.get_jaxpr_for_element()
      • AbstractPipeline.pipeline
      • AbstractPipeline.register_transformer()
  • rubix.pipeline.linear_pipeline module
    • LinearTransformerPipeline
      • LinearTransformerPipeline.apply()
      • LinearTransformerPipeline.build_expression()
      • LinearTransformerPipeline.build_pipeline()
      • LinearTransformerPipeline.update_pipeline()
  • rubix.pipeline.transformer module
    • bound_transformer()
    • compiled_transformer()
    • expression_transformer()
  • Module contents
• rubix.spectra package
  • Subpackages
    • rubix.spectra.ssp package
      • Submodules
      • rubix.spectra.ssp.factory module
      • rubix.spectra.ssp.fsps_grid module
      • rubix.spectra.ssp.grid module
        • HDF5SSPGrid
        • SSPGrid
        • pyPipe3DSSPGrid
      • rubix.spectra.ssp.templates module
      • Module contents
  • Submodules
  • rubix.spectra.ifu module
    • calculate_cube()
    • calculate_diff()
    • convert_luminoisty_to_flux()
    • convert_luminoisty_to_flux_factor()
    • cosmological_doppler_shift()
    • get_velocity_component()
    • resample_spectrum()
    • velocity_doppler_shift()
  • Module contents
• rubix.telescope package
  • Subpackages
    • rubix.telescope.filters package
      • Submodules
      • rubix.telescope.filters.filters module
        • Filter
        • FilterCurves
        • convolve_filter_with_spectra()
        • load_filter()
        • print_filter_list()
        • print_filter_list_info()
        • print_filter_property()
        • save_filters()
      • Module contents
    • rubix.telescope.lsf package
      • Submodules
      • rubix.telescope.lsf.lsf module
        • apply_lsf()
        • apply_lsf_spectra()
        • gaussian1d()
      • Module contents
    • rubix.telescope.psf package
      • Submodules
      • rubix.telescope.psf.kernels module
        • gaussian_kernel_2d()
      • rubix.telescope.psf.psf module
        • apply_psf()
        • get_psf_kernel()
      • Module contents
    • rubix.telescope.noise package
      • Submodules
      • rubix.telescope.noise.noise module
        • calculate_S2N()
        • calculate_noise_cube()
        • sample_noise()
      • Module contents
  • Submodules
  • rubix.telescope.apertures module
    • CIRCULAR_APERTURE()
    • HEXAGONAL_APERTURE()
    • SQUARE_APERTURE()
  • rubix.telescope.base module
    • BaseTelescope
      • BaseTelescope.aperture_region
      • BaseTelescope.fov
      • BaseTelescope.lsf_fwhm
      • BaseTelescope.pixel_type
      • BaseTelescope.sbin
      • BaseTelescope.signal_to_noise
      • BaseTelescope.spatial_res
      • BaseTelescope.wave_edges
      • BaseTelescope.wave_range
      • BaseTelescope.wave_res
      • BaseTelescope.wave_seq
  • rubix.telescope.factory module
    • TelescopeFactory
      • TelescopeFactory.create_telescope()
  • rubix.telescope.utils module
    • calculate_spatial_bin_edges()
    • calculate_wave_edges()
    • calculate_wave_seq()
    • mask_particles_outside_aperture()
    • square_spaxel_assignment()
  • Module contents

Submodules

rubix.debug module

rubix.logger module

rubix.logger.get_logger(config=None)

rubix.paths module

rubix.utils module

rubix.utils.SFTtoAge(a)

Convert scale factor to age in Gyr.

The lookback time is calculated as the difference between current age of the universe and the age at redshift z=1/a - 1.

This hence gives the age of the star formed at redshift z=1/a - 1.

Parameters:

a (float) – scale factor

Returns:

Age in Gyr.

rubix.utils.convert_values_to_physical(value, a, a_scale_exponent, hubble_param, hubble_scale_exponent, CGS_conversion_factor)

Convert values from cosmological simulations to physical units Source: https://kateharborne.github.io/SimSpin/examples/generating_hdf5.html#attributes

Parameters:

• value (float) – Value from Simulation Parameter to be converted

• a (float) – Scale factor, given as 1/(1+z)

• a_scale_exponent (float) – Exponent of the scale factor

• hubble_param (float) – Hubble parameter

• hubble_scale_exponent (float) – Exponent of the Hubble parameter

• CGS_conversion_factor (float) – Conversion factor to CGS units

Returns:

Value in physical units

rubix.utils.get_config(config: str | Dict) → Dict

Get the configuration from a file or a dictionary.

Parameters:

config (Union[str, Dict]) – The configuration as a file path or a dictionary

Returns:

The configuration as a dictionary.

rubix.utils.get_pipeline_config(name: str)

Get the configuration of the pipeline with the given name.

Parameters:

name (str) – The name of the pipeline

Returns:

The configuration of the pipeline as a dictionary.

rubix.utils.load_galaxy_data(path_to_file: str)

load_galaxy_data Load galaxy data from a file

Parameters:

path_to_file (str) – path to the file to load

Raises:

RuntimeError – When an error occurs during loading

Returns:

Either the loaded galaxy data, or an empty dictionary if an error occured.

Example

>>> from rubix.utils import load_galaxy_data
>>> galaxy_data = load_galaxy_data("path/to/file.hdf5")

rubix.utils.print_hdf5_file_structure(file_path)

Print the structure of an HDF5 file.

Parameters:

file_path (str) – path to the HDF5 file

Returns:

The structure of the HDF5 file as a string.

rubix.utils.read_yaml(path_to_file: str) → dict

read_yaml Read yaml file into dictionary

Parameters:

path_to_file (str) – path to the file to read

Returns:

Either the read yaml file in dictionary form, or an empty

dictionary if an error occured.

Module contents