README
changeset 0 5fda18b64dcb
     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/README	Wed Sep 26 17:50:53 2007 -0400
     1.3 @@ -0,0 +1,94 @@
     1.4 +The Fractal Realizer
     1.5 +May 25, 2007
     1.6 +
     1.7 +The Fractal Realizer has been rewritten in Fortran-90.  There are
     1.8 +no longer any pieces of code in C.  The visualization feature (using
     1.9 +DrawPixmap) has been eliminated, since maps can be viewed as XPM files
    1.10 +after running the model.  The new code has been compiled and tested
    1.11 +with gfortran under Linux on an Athlon-64 box.  Example scripts and
    1.12 +data are available in directories below examples/.  The code is in
    1.13 +the src/ directory.  The previous README file is still included here
    1.14 +as README.previous.
    1.15 +
    1.16 +Installation
    1.17 +------------
    1.18 +If you are using gfortran under Linux, simply do the following to build
    1.19 +and install the Fractal Realizer.  Download the code and examples:
    1.20 +
    1.21 +	$ wget http://www.geobabble.org/~hnw/frdist.90
    1.22 +
    1.23 +Then extract the code and examples:
    1.24 +
    1.25 +	$ tar xvzf frdist90.tar.gz
    1.26 +
    1.27 +Next, build the code:
    1.28 +
    1.29 +	$ cd frdist90/src
    1.30 +	$ make
    1.31 +
    1.32 +This will produce the binary program called realizer.  To install the
    1.33 +Fractal Realizer in /usr/local/bin:
    1.34 +
    1.35 +	$ sudo make install
    1.36 +
    1.37 +Execution
    1.38 +---------
    1.39 +
    1.40 +The Fractal Realizer has many options, and some of these are mutually
    1.41 +exclusive. Simply running the executable begins a cascade of questions
    1.42 +from the model which query the user to set up the options for the
    1.43 +simulation run. Responses to the questions direct the subsequent
    1.44 +questions, changing the way that the option tree is traversed. This
    1.45 +verbose interaction mode is a good way to become familiar with the wide
    1.46 +array of Fractal Realizer options. After all questions are answered,
    1.47 +the simulation begins.
    1.48 +
    1.49 +Because answering all of the input questions for each run would be
    1.50 +tedious, the Fractal Realizer writes a script file, inpout.scr, containing
    1.51 +the input answers from the last run. Thus, the last simulation can be
    1.52 +repeated by issuing the command:
    1.53 +
    1.54 +	$ realizer < input.scr
    1.55 +
    1.56 +To change a few input settings, it is not necessary to wade through all
    1.57 +of the input questions again. Instead, simply edit the input.scr script
    1.58 +file directly, and then re-run the simulation using the modified script
    1.59 +file. Mnemonic comments within the script file aid in such editing
    1.60 +process.
    1.61 +
    1.62 +A number of demonstration .scr script files are included in the in the
    1.63 +examples/ directory, and running these "canned" examples is a good way to
    1.64 +test the installation, as well as to see the capabilities of the Fractal
    1.65 +Realizer. Final landscapes and tie maps can be output in several formats,
    1.66 +including XPM and GRASS.
    1.67 +
    1.68 +The FR program uses a heap sort to sort the entire map to find the
    1.69 +highest probability sites, so execution time will increase rapidly as
    1.70 +the size of the map is increased. Execution time also increases with
    1.71 +increasing numbers of categories in the map. Because of the midpoint
    1.72 +displacement algorithm for generating (pseudo)fractals, the maps must
    1.73 +be square, with sides of (2**n)+1. However, the use of constraint masks
    1.74 +will permit oddly-shaped and smaller synthetic maps to be generated
    1.75 +while still preserving both p and the fractal dimension of each category.
    1.76 +
    1.77 +The Fractal Realizer has proven useful and stimulating.  Be sure
    1.78 +to read and cite our paper in Conservation Ecology available at
    1.79 +http://www.ecologyandsociety.org/vol6/iss1/art2/
    1.80 +
    1.81 +Bill and Forrest
    1.82 +-------------------------------------------------------------------------------
    1.83 +William W. Hargrove
    1.84 +Eastern Forest Environmental Threat Assessment Center
    1.85 +USDA Forest Service
    1.86 +Southern Research Station
    1.87 +200 WT Weaver Boulevard
    1.88 +Asheville, NC  28804-3454
    1.89 +-------------------------------------------------------------------------------
    1.90 +Forrest Hoffman                       mailto:forrest@climatemodeling.org
    1.91 +Oak Ridge National Laboratory         mailto:forrest@computer.org
    1.92 +Climate & Carbon Research Institute   http://www.climatemodeling.org/~forrest
    1.93 +Computer Science & Mathematics Div.   (865) 576-7680 voice
    1.94 +Building 5600, Room C221, MS 6016     (865) 576-5491 fax
    1.95 +P.O. Box 2008                         Deliveries: Bethel Valley Road
    1.96 +Oak Ridge TN 37831-6016               35� 55' 23" N   84� 19' 20" W
    1.97 +-------------------------------------------------------------------------------