Full Documentation | View on Github | Download Stable ZIP

sf3dmodels is a star forming region(s) modelling package that brings together analytical models in order to compute their physical properties in a 3-Dimensional grid. The package can couple different models in a single grid to recreate complex star forming systems as those being revealed by current instruments. The output data can be read with LIME (see below) or RADMC-3D to carry out radiative transfer calculations of the modelled region.

Find the full documentation and examples on the sf3dmodels website.

• Python 2.7.x or 3.5.x (or later)
• Astropy
• Numpy
• Matplotlib
• IPython (optional, but recommended)

Clone the star-forming-regions repository from GitHub:

To clone the package, if you have a github account:

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 cloned folder and run the setup.py script in installation mode:

cd star-forming-regions
python setup.py install

You can test whether the installation was successful by running an example from star-forming-regions/examples.

cd star-forming-regions
git fetch --all
git reset --hard origin/master
git submodule update --force --remote -- lime
python setup.py install

pip uninstall sf3dmodels

The package contains the standard LIME v1.9.5 + an additional feature for sf3dmodels users. An ingestor was included within the LIME source codes, it allows the user to employ the sf3dmodels output as the LIME input.

LIME must be configured separately once the sf3dmodels package has been installed with success.

The installation procedure of this LIME is identical to its standard installation (have a look at the LIME installation notes section). Make sure you are configuring and setting everything in/to the LIME directory included in this repository.

The ingestor will look for the .dat files generated by sf3dmodels and load them within the LIME environment. To invoke this option, a -S flag (uppercase) must be added in the usual LIME running command as follows:

lime -S model.c

The standard LIME command line options may also be invoked. For instance, to set LIME to (1.) produce normal output rather than the default ncurses output style, (2.) read the sf3dmodels output and (3.) run in parallel mode with 4 threads you should execute:

lime -nS -p 4 model.c

Note that if the -S option is not set you will get back the 'traditional' operation of LIME.

Take a look at the folder lime/example_sf3dmodels/ included in this repository.

• Andres Izquierdo
• Roberto Galvan-Madrid
• Adam Ginsburg
• Luke Maud

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.

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}
}