wiki:StepByStep

Version 20 (modified by Gary J. Ferland, 11 years ago) (diff)

--

Step by step instructions for installing Cloudy

This page contains instructions for installing the current stable version of Cloudy. The code is installed in a series of steps: a) download the files into separate directories, b) edit the file "path.cpp" to tell the code where the atomic data are located, c) compile the source, d) run the smoke test, the single command "test", e) download and compile any ancillary stellar continua you want to use, f) run the test suite in tsuite/auto to verify that your system works, and finally g) apply any hot fixes.

Hazy, the code's documentation, is included in the download. You can download Hazy here if that is all that you need. Otherwise obtain the full download as described below.

Each version of the code has a set of pages giving updates. The HotFixes page lists corrections that need to be made to the downloaded source. These are bug fixes that were not included in the version of the code used to generate the output from the test suite. So the hot fixes should be applied after the test suite has been run and your system validated. A KnownProblems page will list known problems with that version of the code. The revision history page lists improvements.

Cite the code by giving the version number and a reference to the last major review of Cloudy, Ferland et al. (1998; PASP, 110, 761, available here). An example would be “We used version 05.07b of Cloudy, last described by Ferland et al. (1998)”. Then, years from now, when someone wants to know how an answer was obtained, the version used to obtain it can be retrieved from the old versions part of this web site. The print citation command will print the correct citation for the version you are using.

Setting up this version

  1. DownLoad the code, data, and documentation. This creates several directories, Each contains a readme.htm file describing the contents of that directory.
  1. EditPath - instructions for how to modify the file path.cpp to specify where the data files are located.
  1. CompileCode - how to compile the code using a variety of compilers.
  1. RunCode - This explains how to execute the code and run a smoke test.
  1. CompileStars - You must compile some stellar data files if you want to use the some of the table star command to include realistic stellar continua.
  1. TestSuite is a large number of test cases that you should run to confirm that all is well. This is a critical step since it will check for bugs in your compiler. That directory also contains a group of programs that show how to call the code as a subroutine.
  1. HotFixes are a set of corrections to the source. These will be incorporated in the next incremental upgrade, are listed in the Hot Fixes page. It is very important that you edit the source to incorporate these hot fixes since they correct known problems. The source you obtain here does not have any of these these fixes included. (Reason: this is the source that created the output files that are downloaded with the test suite. You can validate your system/compiler by confirming that this source reproduces that output. This source and output constitute a reference for where the code was at a particular time.)
  1. KnownProblems are described on this page.

A diversion

While doing all that downloading/compiling/testing you might be interested in hearing Cloudy's favorite song in mp3 format (from Simon & Garfunkel's Parsley, Sage, Rosemary and Thyme).