In a hurry? Quick-start.

Overview

MARTINI is a modular package for the creation of synthetic resolved HI line observations (data cubes) of smoothed-particle hydrodynamics simulations of galaxies. The various aspects of the mock-observing process are divided logically into sub-modules handling the data cube, source, beam, noise, spectral model and SPH kernel. MARTINI is object-oriented: each sub-module provides a class (or classes) which can be configured as desired. For most sub-modules, base classes are provided to allow for straightforward customization. Instances of each sub-module class are given as parameters to the Martini class; a mock observation is then constructed by calling a handful of functions to execute the desired steps in the mock-observing process.

Documentation contents

• Getting Started
  • Installation notes
  • Quickstart guide
• Sources
  • Sources in MARTINI
  • Units in MARTINI
  • Using MARTINI’s source classes
  • Manipulating a source before making a mock
  • Inspecting a source before making a mock
• Data cubes
  • Data cubes in MARTINI
  • Using MARTINI’s DataCube class
• Beams
  • Beams in MARTINI
  • Using MARTINI’s beam classes
• Noise
  • Noise in MARTINI
  • Using MARTINI’s noise classes
• SPH kernels
  • SPH kernels in MARTINI
  • Smoothing lengths in MARTINI
  • Using MARTINI’s SPH kernel classes
• Spectral Models
  • Spectral models in MARTINI
  • Using MARTINI’s spectral model classes
• Martini: core routines
  • Putting it all together
  • Inserting the source
  • Adding noise
  • Convolving the beam
  • All done!
• Global profile mode
  • Assumptions and limitations
  • Usage
  • Inserting the source
  • Quick plot of the spectrum
• API Documentation
  • martini package
• Indices and tables

Citing Martini

If your use of MARTINI leads to a publication, please acknowledge this and link to the github page, ideally specifying the version used (git commit ID or version number). Please cite the MARTINI entry in the ASCL (indexed on ADS), and the original paper:

@MISC{
    2019ascl.soft11005O,
    author = {{Oman}, Kyle A.},
    title = "{MARTINI: Mock spatially resolved spectral line observations of simulated galaxies}",
    keywords = {Software},
    howpublished = {Astrophysics Source Code Library, record ascl:1911.005},
    year = 2019,
    month = nov,
    eid = {ascl:1911.005},
    pages = {ascl:1911.005},
    archivePrefix = {ascl},
    eprint = {1911.005},
    adsurl = {https://ui.adsabs.harvard.edu/abs/2019ascl.soft11005O},
    adsnote = {Provided by the SAO/NASA Astrophysics Data System}
}

@ARTICLE{
    2019MNRAS.482..821O,
    author = {{Oman}, Kyle A. and {Marasco}, Antonino and {Navarro}, Julio F. and {Frenk}, Carlos S. and {Schaye}, Joop and {Ben{\'\i}tez-Llambay}, Alejandro},
    title = "{Non-circular motions and the diversity of dwarf galaxy rotation curves}",
    journal = {\mnras},
    keywords = {ISM: kinematics and dynamics, galaxies: haloes, galaxies: structure, dark matter, Astrophysics - Astrophysics of Galaxies, Astrophysics - Cosmology and Nongalactic Astrophysics},
    year = 2019,
    month = jan,
    volume = {482},
    number = {1},
    pages = {821-847},
    doi = {10.1093/mnras/sty2687},
    archivePrefix = {arXiv},
    eprint = {1706.07478},
    primaryClass = {astro-ph.GA},
    adsurl = {https://ui.adsabs.harvard.edu/abs/2019MNRAS.482..821O},
    adsnote = {Provided by the SAO/NASA Astrophysics Data System}
}

Work that has used MARTINI includes: Oman et al. (2019), Mancera Piña et al. (2019), Chauhan et al. (2019), Mancera Piña et al. (2020), Santos-Santos et al. (2020), Glowacki et al. (2021), Bilimogga et al. (2022), Glowacki et al. (2022), Roper et al. (2023) and Oman et al. (2024). The ALMASim package (Guglielmetti et al. 2023) builds on some of MARTINI’s functionality. If your work has used MARTINI and is not listed here, please let me know (by email or github issue).

Indices and tables

• Index

• Module Index

• Search Page