Twind

Twind is a Python prototype of TIGRESS Multiphase Wind Launching Model. The model is built on the TIGRESS simulation suite developed as part of the SMAUG project.

Basic Usage

If you want to obtain scaling relations between wind (mass, momentum, energy, and metal) loading factors and star formation rate surface density at different escape velocity cuts, you would construct PDFs with Twind:

import twind

tw = twind.TigressWindModel(z0='H',verbose=True)
tw.set_axes(verbose=True)
pdf = tw.build_model(renormalize=True,energy_bias=True)

This will return 3D PDFs in the \((v_{\rm out}, c_s, \Sigma_{\rm SFR})\) space. A more complete example is available in the Quickstart tutorial.

pdf stores all information using xarray. Then, additional manipulations are easy. If you want to apply velocity cuts to get loading factors with a selected condition, you would do something like:

dbinsq = pdf.attrs['dlogcs']*pdf.attrs['dlogvout']
cdf_over_vB100 = pdf['Mpdf'].where(pdf['vBz']>100).sum(dim=['logcs','logvout'])*dbinsq
etaM_over_vB100 = pdf['etaM']*cdf_over_vB100

You can get a quick and dirty plot for the mass loading factor:

etaM_over_vB100.plot()

A more complete example is available in the Loading Factors from 3D PDFs tutorial.

User Guide

• Installation
  • Github sources
  • Package managers
• Joint PDF Model
  • Cool outflow model
  • Hot outflow model

Tutorials

• Quickstart
• Loading Factors from 3D PDFs
• Particle Sampling

TIGRESS Simulation Suite

• Simulation Model Tables
• Simulation PDFs

Examples

• Figures in Paper II

API Reference

• API Reference

License & Attribution

Twind is free software made available under the MIT License.

If you make use of Twind in your work, please cite our papers:

• Kim et al. 2020a, ApJ, 900, 61 First results from SMAUG: Characterization of Multiphase Galactic Outflows from a Suite of Local Star-Forming Galactic Disk Simulations [arXiv, ADS, BibTeX]
• Kim et al. 2020b, ApJL submitted TIGRESS Multiphase Wind Launching Model [links].