# Read me for Cloudy source

## Setting up and running the code

Instructions are web-based since this insures the most up-to-date advice. The web site is http://www.nublado.org/ Go to the downloads pages and follow the instructions for the version you are setting up. You probably probably want the current gold version.

## Helper applications

These are a series of perl scripts that live in the source directory and perform certain automated tasks.

extract_atomic_data.pl will read the files in the source, test suite, and data directories and extract all atomic data references. It creates the files atomic_data_refer.txt and atomic_data_refer_old.txt. These are tab-delimited tables that give references contained within the code.

list_routines.pl will look at all the source files and make a list of routine names and their purpose. The output files are list_routines.html, an html file listing the results, and list_routine s.txt.

list_headers.pl makes a list of all header files, with each name followed by a list of all the source files that contain references to that header. The list is produced in the file listfiles.txt.

todo_search.pl - makes list of all TODO statements in code, in order of decreasing priority. Creates files todo_table.txt and todo_table.htm.

## Comments or suggestions?

Please send comments or suggestions to Gary Ferland at gary@pa.uky.edu
Visit http://www.nublado.org for details and latest updates.

Good luck,
Gary J. Ferland

reviewed 23-Dec-2005