sf3dmodels: A Python repository from andizq

Full Documentation | View on Github | Download Stable ZIP

sf3dmodels

sf3dmodels is a 3D modelling package that collects analytical prescriptions of gas/dust envelopes, discs, outflows and filaments in order to reproduce complex star-forming systems such as those being revealed by state-of-the-art telescopes. The package can (i) model individual/isolated objects or, alternatively, (ii) couple multiple models in a single grid to recreate composite regions.

The output model can then be read with LIME, RADMC-3D or Polaris to compute the radiative transfer of the modelled region, which is a key step prior comparison to real observations.

The sf3models grid and rt (radiative transfer) modules can also be used as wrappers between hydrodynamical simulations and radiative transfer codes. These modules are especially dedicated to treat irregular meshes (e.g. Voronoi meshes or SPH grid particles).

Take a look at the following examples linking AREPO and Phantom hydrodynamical simulations with Polaris and LIME.

AREPO examples

Phantom examples

Documentation

Find the full documentation and tutorials on the sf3dmodels website.

Requirements

Python 2.7.x 3.5.x (or later)
Astropy
Numpy
Matplotlib
IPython (recommended)

Installation

From source

Clone the star-forming-regions repository from GitHub:

If you have a github account, type in a terminal:

git clone git@github.com:andizq/star-forming-regions.git

if you don't have one:

git clone https://github.com/andizq/star-forming-regions.git

Get into the star-forming-regions folder and run the setup.py script in installation mode:

cd star-forming-regions
python setup.py install

You can run any example from star-forming-regions/examples to check if the installation was succesful.

Update the package

cd star-forming-regions
git pull
python setup.py install

Uninstall

pip uninstall sf3dmodels

Developers

We thank collaborators who have reported bugs or whose ideas and discussions have helped improve sf3dmodels,

Rowan Smith
Yuxin Lin
Antonio Hernandez
Jonathan Henshaw
Qizhou Zhang
Leonardo Testi
Stefano Facchini
Ewine van Dishoeck
Pietro Curone
Carlos Carrasco-González
Adriana Rodríguez-Kamenetzky

Papers using sf3dmodels

License

This project is Copyright (c) Andres Izquierdo and licensed under the terms of the BSD 3-Clause license. This package is based upon the Astropy package template which is licensed under the BSD 3-clause licence. See the licenses folder for more information.

Citing sf3dmodels

If you find sf3dmodels useful for your research please cite the work of Izquierdo et al. (2018):

@ARTICLE{2018MNRAS.478.2505I,
   author = {{Izquierdo}, Andr{\'e}s F. and {Galv{\'a}n-Madrid}, Roberto and
             {Maud}, Luke T. and {Hoare}, Melvin G. and {Johnston}, Katharine G. and
             {Keto}, Eric R. and {Zhang}, Qizhou and {de Wit}, Willem-Jan},
   title = "{Radiative transfer modelling of W33A MM1: 3D structure and dynamics of a complex massive star-forming region}",
   journal = {\mnras},
   keywords = {radiative transfer, stars: formation, stars: massive, stars: protostars, Astrophysics - Astrophysics of Galaxies, Astrophysics - Solar and Stellar Astrophysics},
   year = "2018",
   month = "Aug",
   volume = {478},
   number = {2},
   pages = {2505-2525},
   doi = {10.1093/mnras/sty1096},
   archivePrefix = {arXiv},
   eprint = {1804.09204},
   primaryClass = {astro-ph.GA},
   adsurl = {https://ui.adsabs.harvard.edu/abs/2018MNRAS.478.2505I},
   adsnote = {Provided by the SAO/NASA Astrophysics Data System}
}

andizq/sf3dmodels