Documenation for SimIM

These pages contain documentation for SimIM a Python package for simulating the extragalactic sky in radio, sub-millimeter, and far-infrared.

Getting Started

• Installing SimIM
  • Requirements
  • From PyPI
  • From GitHub
• Downloading Simulation Data
  • Simulation Access with SimIM
  • Downloading a Simulation
  • Partial Simulation Downloads
  • Additional Simulations
• The SimIM Interface for Halo Catalogs
  • Simulation and Snapshot Metadata
  • Simulation Snapshots and SnapHanlder
  • Direct Access to Halo/Galaxy Properties
  • Adding Properties to Simulations
  • Interacting with a Simulation Across All Snapshots
• Making Light Cones
  • Interacting with Lightcones

Simulation Interface

• The siminterface Module
  • Interacting with Simulations Using SimIM
    • SimHandler
    • SnapHandler
  • Downloading and Formatting Simulations
    • IllustrisCatalogs
    • UniversemachineCatalogs
  • Under the Hood
    • SimCatalogs
    • Snapshot

Galaxy Properties

• The galprops Module
• Prop and GalProp Classes
  • Prop
    • Prop.evaluate()
  • MultiProp
    • MultiProp.evaluate_all()
    • MultiProp.evaluate()
• Pre-Packaged Galaxy Properties
  • Stellar Masses and Star Formation Rates
    • behroozi13_base
    • sfr()
    • stellarmass()
    • bethermin17_base
    • g13irlf_base
  • Spectral Line Luminosities
    • Carbon Monoxide
    • HCN
    • Far-Infrared
  • Star Formation Rates and Stellar Masses
    • behroozi13_base
    • sfr()
    • stellarmass()
  • Helper Functions
    • log10normal()

Ligth Cones

• The lightcone Module
  • Making Light Cones
    • LCMaker
  • The Light Cone Handler
    • LCHandler

Grids, Maps, Spectral Cubes

• The map Module
  • Grid
    • Grid.init_grid()
    • Grid.pad()
    • Grid.crop()
    • Grid.scale_axis()
    • Grid.copy_axes()
    • Grid.copy()
    • Grid.save()
    • Grid.add_new_prop()
    • Grid.add_from_cat()
    • Grid.add_from_pos_plus_array()
    • Grid.add_from_spec_func()
    • Grid.sum_properties()
    • Grid.sample()
    • Grid.convolve()
    • Grid.down_sample()
    • Grid.collapse_dimension()
    • Grid.fourier_transform()
    • Grid.power_spectrum()
    • Grid.spherical_average()
    • Grid.visualize()
    • Grid.animate()
  • Creating Data Cubes
    • Gridder
    • gridder_function()
  • PSFs
    • PSF
    • SpectralPSF
    • GridFromAxesAndFunction

Instrument Modeling

• The instrument Module
  • Tools For Modeling Instruments
    • Instrument
    • Detector
  • Spatial Response Functions
  • Spectral Response Functions
  • Noise Functions