-
Notifications
You must be signed in to change notification settings - Fork 5
/
Copy pathreadme-rescal1.6.txt
196 lines (140 loc) · 6.42 KB
/
readme-rescal1.6.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
2019 update:
This is the readme for ReSCAL v1.6, 2016,
and the examples and dependencies are now outdated.
Refer to README.md for up-to-date information.
ReSCAL: a Real-Space Cellular Automaton Laboratory
--------------------------------------------------
Copyright (C) 2011-2016
(2019 note: this readme describes ReSCAL v1.6 in 2016.
The current software has been modified from this;
see README.md for a description of the current state
of this software)
Description
-----------
This is ReSCAL, a cellular automaton modeling tool in real 3d space,
primarily designed for geomorphology. However we believe it is
sufficiently generic in its approach to deal with a wide range of
applications.
Basically, it simulates asynchronous first-neighbour interactions
(see the papers in the References section). We refer to Markov
chains and Poisson processes for the evolution of the physical time.
We also implemented a number of additional mechanisms that are
relevant in usual geophysical models
- correlations (coupled processes)
- avalanches (granular processes)
- lattice gas coupling (erosion)
- rotating table (multidirectional winds)
- map surrections (tectonic processes)
Content
-------
ReSCAL package comprises several programs:
- rescal: ReSCAL main application
- genesis: generation of a 3d cellular space (CSP or raw binary format)
- regenesis: modification of a cellular space
- csp2png: PNG image generator from CSP-file
- bin2png: PNG image generator from BIN-file
- cspinfo: CSP metadata reader
- csp2bin: CSP to raw binary conversion tool
Samples are present in the scripts directory, along with Matlab/octave
functions that support CSP format.
Requirements
------------
Needed libraries are glib-2.0, gtk+-2.0, gdk-pixbuf and pthread.
'genesis.py' uses NumPy, but it is possible to use C version of
genesis instead.
Getting started
---------------
1) Build all programs by typing
./configure
make
(See also 'INSTALL' file for detailled instructions)
2) Go to the scripts directory and launch the 'run' script:
cd scripts
./run
This will open a window, with no menu, displaying a dunes simulation
controlled by air flow. Note the initial phase of flow stabilization.
The environment variable OMP_NUM_THREADS lets you set the number of
OpenMP threads in the computation of the flow. You can get optimal
speed by setting this variable according to the number of available
CPU cores.
(See rescal command line options to customize display preferences
in the script)
3) Edit the 'run' script and change the value of PAR_FILE:
PAR_FILE="dun_rot.par"
Then launch rescal again:
./run
Now you have a similar execution, with rotations occuring regularly,
as if the wind was rotating. Again the flow needs to be stabilized
after each rotation.
4) Edit a parameter file, change some values and see what happens in
your model.
For example, you can change the overall size by editing the 'H', 'L',
'D' parameters in 'dun.par'.
H = heigth (vertical)
L = length (from east to west)
D = depth (from north to south)
Beware that a huge cellular space will slow down the simulation.
Another suggestion would be to choose a predefined CSP template for
the initial configuration of the cellular space. For example, you can
get a conical pile of sand by setting:
Csp_template = RCONE
5) Save the output files of your last simulation by using the 'xrep'
script.
Advanced usage
--------------
It is possible to select and/or modify any of the predefined models.
So far, this requires to edit some of the sources in C language.
Here we briefly explain how to proceed. Ideally, we assume
that the user have some notion of programming.
1) Edition of genesis sources
The genesis program is provided in python and C languages. These two
standalone versions are respectively located in 'scripts' and
'src' directories. The python version of genesis is easier to
read, however it does not support the CSP format yet, nor any of the
CSP templates.
Note that for historical reasons, a cellular space is composed of
vertical plans in the east-west direction. Each plan is a
concatenation of horizontal lines from left to right. The very first
cell corresponds to the north-upper-left corner.
When lattice gas is used, a floor and a ceiling of DUM cells are
required to prevent gas particles from escaping the cellular space.
2) Edition of rescal sources
Start by selecting a model and its specific options, in 'defs.h'.
You may also edit the transitions in 'models.c'. Basically, the
syntax looks like
trans(direction, cel1_start, cel2_start, cel1_end, cel2_end, rate).
Then you will get an oriented transition
[cel1_start, cel2_start] -> [cel1_end, cel2_end]
occuring at the specified rate. See USER'S GUIDE in 'models.c' for
an overview of the available functions.
Use the command-line option '-info' to generate a number of log files.
For instance, the list of all transitions is present in 'TRANS.log'.
Feel free to have a look around and play with the existing mechanisms
in 'space.c' and 'surface.c', or to suggest any improvement you would
like to see. Obviously, there is still a lot left to do ! (See the
TODO file)
A modified version can be freely distributed provided that you keep
intact all the notices that refer to the license (See 'COPYING' file).
We would be grateful if you mention the use of this program in a
related work or publication.
References
----------
[1] On a small scale roughness of the core-mantle boundary
C. Narteau, J.L. Le Mouël, J.P. Poirier, E. Sepulveda and M. Shnirman
Earth and Planetary Science Letters, 191, 49-60 (2001).
[2] Setting the length and time scales of a cellular automaton dune
model from the analysis of superimposed bedforms
C. Narteau, D. Zhang, O. Rozier and P. Claudin
Journal Geophysical Research, 114, F03006 (2009).
[3] Morphodynamics of barchan and transverse dunes using a cellular
automaton model
D. Zhang, C. Narteau and O. Rozier
Journal Geophysical Research, 115, F03041 (2010).
========================================================================
ReSCAL is free software; you can redistribute it and/or modify it under the
terms of the GNU General Public License as published by the Free Software
Foundation. It is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY WHATSOEVER.
Check the License for details. You should have received a copy of it, along
with the package; see the file 'COPYING'. If not, write to the Free Software
Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.