Sirocco (Simulating Ionization and Radiation in Outflows Created by Compact Objects) is a Monte Carlo radiative transfer code which uses the Sobolev approximation. The code was formerly known as Python and renamed in October 2024. It has been developed by Knox Long, Christian Knigge, Stuart Sim, Nick Higginbottom, James Matthews, Sam Manghamm Edward Parkinson, Mandy Hewitt and Nico Scepi. The code has been used for a variety of research projects invovling the winds of cataclysmic variables, young stellar objects, X-ray binaries and AGN.

The code is under active development, but we are looking for beta users to test the code, and potentially use it for their own research. If you are interested in using Sirocco please contact Knox Long via long[at]stsci[dot]edu or James Matthews via james[dot]matthews[at]physics[dot]ox[dot]ac[dot]uk.

Documentation is hosted on [ReadTheDocs]((https://sirocco-rt.readthedocs.io).

Installation

Sirocco and the various routines associated are set up in a self-contained directory structure. The basic directory structure and the data files that one needs to run Sirocco need to be retrieved and compiled.

If you want to obtain a stable (!) release, go to the Releases page.

If you want to download the latest dev version, you can zip up the git repository by clicking on the zip icon to the right of the GitHub page. Aternatively, you can clone the repository using

$ git clone https://github.com/sirocco-rt/sirocco.git 

If you anticipate contributing to development we suggest forking the repository and submitting pull requests with any proposed changes.

Once you have the files, you need to cd to the new directory and set your environment variables

$ export SIROCCO = /path/to/sirocco/
$ cd $SIROCCO
$ ./configure
$ make install  (or better make install 2>&1 | tee today.txt)
$ make clean

If you have any difficulties with the installation, please submit an issue, along with the file today.txt

Note that the export syntax is for bash- for csh use

$ setenv SIROCCO /path/to/sirocco/

Atomic data for the current version of Sirocco stored in the directory xdata which is part of the main repository,

However, if one wishes to use model stellar spectra to simulate the spectra of the star or disk, one my wish to also to download various model grids of spectra that have been used in conjunction with Sirocco/Python over the years. These are in a separate [models repository]((https://github.com/sirocco-rt/xmod).

These can be downloaded as follows:

$ cd $SIROCCO; git clone https://github.com/sirocco-rt/xmod xmod 

(Previously, both the atomic data and the model grids were stored in a separate repository. Users wishing to run older versions of the code pre-84b may need to download the old data repository This repository can be downloaded as follows

$ cd $SIROCCO; git clone https://github.com/sirocco-rt/data data

Those users interested in the current version of Sirocco should not need to do this)

Running Sirocco

To run Sirocco you need to add the following to your $PATH variable:

$SIROCCO/bin

You can then setup your symbolic links by running

$ Setup_Sirocco_Dir

and run the code by typing, e.g.

$ sirocco root.pf

Please see the ReadTheDocs or the docs folder for how to use the code. You will need sphinx installed to build the documentation yourself.

Any comments, email one of the addresses above.