Developer Tools

Several scripts have been written to assist in developing and documenting SIROCCO.

Documentation

autogenerate_parameter_docs	Generates .yml format descriptions of the parameters in the C files.
autogenerate_rtd_pages	Converts .yml format parameter descriptions to .rst files.
dox	Check whether c routines have proper dox headers, and if not write a new file with a dummy dox header for the user to update
dox_check	Determine which files lack doxygen commments

Development

add_param	The purpose of this routine is to add a new parameter to an existing parameter file.
update_param	Use this script to (mass) update either the name of a parameter or to update the value of a parameter.
run_indent	Indent in a controlled manner the .c files used by Python
init_extern	Create a .c file which initializes all of the externs in a .h file.
make_rtheta	Create a simple rtheta import file that can be used with Sirocco.
pf_check	Checks if .pf files in a directory need modification.
CheckAtomic	Summarize an atomic data file in order to see how large arrays defined in atomic.h must be
retro	Run multiple commits on the same .pf file to see where changes arose.