README
author Forrest Hoffman <forrest@climatemodeling.org>
Wed, 26 Sep 2007 17:50:53 -0400
changeset 0 5fda18b64dcb
permissions -rw-r--r--
Initial commit of the Fortran-90 version of the Fractal Realizer.
forrest@0
     1
The Fractal Realizer
forrest@0
     2
May 25, 2007
forrest@0
     3
forrest@0
     4
The Fractal Realizer has been rewritten in Fortran-90.  There are
forrest@0
     5
no longer any pieces of code in C.  The visualization feature (using
forrest@0
     6
DrawPixmap) has been eliminated, since maps can be viewed as XPM files
forrest@0
     7
after running the model.  The new code has been compiled and tested
forrest@0
     8
with gfortran under Linux on an Athlon-64 box.  Example scripts and
forrest@0
     9
data are available in directories below examples/.  The code is in
forrest@0
    10
the src/ directory.  The previous README file is still included here
forrest@0
    11
as README.previous.
forrest@0
    12
forrest@0
    13
Installation
forrest@0
    14
------------
forrest@0
    15
If you are using gfortran under Linux, simply do the following to build
forrest@0
    16
and install the Fractal Realizer.  Download the code and examples:
forrest@0
    17
forrest@0
    18
	$ wget http://www.geobabble.org/~hnw/frdist.90
forrest@0
    19
forrest@0
    20
Then extract the code and examples:
forrest@0
    21
forrest@0
    22
	$ tar xvzf frdist90.tar.gz
forrest@0
    23
forrest@0
    24
Next, build the code:
forrest@0
    25
forrest@0
    26
	$ cd frdist90/src
forrest@0
    27
	$ make
forrest@0
    28
forrest@0
    29
This will produce the binary program called realizer.  To install the
forrest@0
    30
Fractal Realizer in /usr/local/bin:
forrest@0
    31
forrest@0
    32
	$ sudo make install
forrest@0
    33
forrest@0
    34
Execution
forrest@0
    35
---------
forrest@0
    36
forrest@0
    37
The Fractal Realizer has many options, and some of these are mutually
forrest@0
    38
exclusive. Simply running the executable begins a cascade of questions
forrest@0
    39
from the model which query the user to set up the options for the
forrest@0
    40
simulation run. Responses to the questions direct the subsequent
forrest@0
    41
questions, changing the way that the option tree is traversed. This
forrest@0
    42
verbose interaction mode is a good way to become familiar with the wide
forrest@0
    43
array of Fractal Realizer options. After all questions are answered,
forrest@0
    44
the simulation begins.
forrest@0
    45
forrest@0
    46
Because answering all of the input questions for each run would be
forrest@0
    47
tedious, the Fractal Realizer writes a script file, inpout.scr, containing
forrest@0
    48
the input answers from the last run. Thus, the last simulation can be
forrest@0
    49
repeated by issuing the command:
forrest@0
    50
forrest@0
    51
	$ realizer < input.scr
forrest@0
    52
forrest@0
    53
To change a few input settings, it is not necessary to wade through all
forrest@0
    54
of the input questions again. Instead, simply edit the input.scr script
forrest@0
    55
file directly, and then re-run the simulation using the modified script
forrest@0
    56
file. Mnemonic comments within the script file aid in such editing
forrest@0
    57
process.
forrest@0
    58
forrest@0
    59
A number of demonstration .scr script files are included in the in the
forrest@0
    60
examples/ directory, and running these "canned" examples is a good way to
forrest@0
    61
test the installation, as well as to see the capabilities of the Fractal
forrest@0
    62
Realizer. Final landscapes and tie maps can be output in several formats,
forrest@0
    63
including XPM and GRASS.
forrest@0
    64
forrest@0
    65
The FR program uses a heap sort to sort the entire map to find the
forrest@0
    66
highest probability sites, so execution time will increase rapidly as
forrest@0
    67
the size of the map is increased. Execution time also increases with
forrest@0
    68
increasing numbers of categories in the map. Because of the midpoint
forrest@0
    69
displacement algorithm for generating (pseudo)fractals, the maps must
forrest@0
    70
be square, with sides of (2**n)+1. However, the use of constraint masks
forrest@0
    71
will permit oddly-shaped and smaller synthetic maps to be generated
forrest@0
    72
while still preserving both p and the fractal dimension of each category.
forrest@0
    73
forrest@0
    74
The Fractal Realizer has proven useful and stimulating.  Be sure
forrest@0
    75
to read and cite our paper in Conservation Ecology available at
forrest@0
    76
http://www.ecologyandsociety.org/vol6/iss1/art2/
forrest@0
    77
forrest@0
    78
Bill and Forrest
forrest@0
    79
-------------------------------------------------------------------------------
forrest@0
    80
William W. Hargrove
forrest@0
    81
Eastern Forest Environmental Threat Assessment Center
forrest@0
    82
USDA Forest Service
forrest@0
    83
Southern Research Station
forrest@0
    84
200 WT Weaver Boulevard
forrest@0
    85
Asheville, NC  28804-3454
forrest@0
    86
-------------------------------------------------------------------------------
forrest@0
    87
Forrest Hoffman                       mailto:forrest@climatemodeling.org
forrest@0
    88
Oak Ridge National Laboratory         mailto:forrest@computer.org
forrest@0
    89
Climate & Carbon Research Institute   http://www.climatemodeling.org/~forrest
forrest@0
    90
Computer Science & Mathematics Div.   (865) 576-7680 voice
forrest@0
    91
Building 5600, Room C221, MS 6016     (865) 576-5491 fax
forrest@0
    92
P.O. Box 2008                         Deliveries: Bethel Valley Road
forrest@0
    93
Oak Ridge TN 37831-6016               35� 55' 23" N   84� 19' 20" W
forrest@0
    94
-------------------------------------------------------------------------------