Tutorials & Plotting
SIROCCO produces a large number of files in both binary and ascii format. Tools exist to examine the binary files.
PySi
PySi, short for PySIROCCO, is a python package designed to interface with the SIROCCO code. It can be installed from its own Github repository under the sirocco-rt organisation. We recommend installing this package for reading code outputs.: instructions to do so can be found in the README of that repository.
The API documentation for PySi can be found here.
PySi can also be used from the command line. For example, the command
pysi plot spectrum observer [model_name]
will allow you to plot a spectrum, whereas
pysi plot wind property [model_name] [variable]
will allow you to plot the wind property specified by [variable]. For more flexibility, see the tutorials.
Warning to users!
These tutorials are not complete, and our approach to interfacing with the code has not been uniform across the collaboration. Nevertheless, these tutorials should give you the basic tools needed to look at spectra and wind properties, with more detail on python scripts and packages provided in the API documentation.
