-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathREADME_v4.1
194 lines (146 loc) · 8.04 KB
/
README_v4.1
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
CICE version 4.1
May, 2010
This directory contains files needed to run version 4.1 of CICE, the
LANL sea ice model, in standalone mode on a 3 degree grid. As
currently configured, the model runs on 4 processors. MPI is used for
message passing between processors. The grid provided here is too
small for the code to scale well beyond about 8 processors. A 1 degree
grid is provided also, without forcing data. If you want to run on a
single processor without using MPI, edit comp_ice.
For additional information, please consult the CICE documentation
'cicedoc.pdf', found at http://climate.lanl.gov/Models/CICE/ or in the
code distribution, in the directory doc/. This README file contains
introductory material only. For troubleshooting, please consult
Section 5 of the pdf documentation.
--- To compile and run the model ---
In the source directory:
1. Create Macros.<OS>* and run_ice.<OS>* files for your particular platform,
if they do not already exist (type 'uname -s' at the prompt to get <OS>).
2. Alter directories in the script comp_ice.
3. Run comp_ice to set up the run directory and make the executable 'cice'.
4. To clean the compile directory and start fresh, alter directories in
the script clean_ice and execute it.
In the run directory:
5. Alter atm_data_dir in the namelist file ice_in.
6. Alter the script run_ice for your system.
7. Execute run_ice (see forcing data information below).
Output files (in the run directory):
ice.log* diagnostic output normally written to the screen, if
using the run_ice script or one like it
restart/iced* restart files written at the "dump" frequency in ice_in
hist/iceh* output of numerous model variables as instructed by ice_in
When restart files are written, the filename is written into the file
restart/ice.restart_file
--- Forcing data information ---
The code is currently configured to run in standalone mode on a 3 degree
grid using atmospheric data from 1997, available from
http://climate.lanl.gov/Models/CICE/. These data files are
designed only for testing the code and are not necessarily the best
observational data. Please do not publish results based on these data
sets. Module ice_forcing.F90 can be modified to change the forcing
data.
--- initial directory structure and contents ---
cice/
README_v4.1 this file
clean_ice script that cleans out compile directory
comp_ice script that sets up and compiles the code
ice.log.<OS>* sample diagnostic output files
cice/bld
Macros.<OS>* macro definitions for the given operating system
Makefile.<OS> makefile for the given operating system
makdep.c script that determines module dependencies
cice/csm_share modules based on "shared" code in CCSM
shr_orb_mod.F90 orbital parameterizations
cice/doc/
cicedoc.pdf Documentation and Software User's Manual
PDF/ PDF documents of numerous publications related to CICE
cice/drivers/ institution-specific modules
cice/drivers/cice4 official driver for CICE version 4.0 (LANL)
cice/drivers/esmf Earth System Modeling Framework driver
CICE.F90 main program
CICE.F90_debug debugging version of CICE.F90
CICE_FinalMod.F90 routines for finishing and exiting a run
CICE_InitMod.F90 routines for initializing a run
CICE_RunMod.F90 main driver routines for time stepping
ice_constants.F90 physical and numerical constants and parameters
cice/input_templates/
run_ice.<OS>* batch script for the given operating system
cice/input_templates/gx1/
global_gx1.grid 0.9 x 1.1 deg displaced pole grid, 'gx1'
global_gx1.kmt 0.9 x 1.1 deg land mask (N pole is in Greenland)
ice.restart_file pointer with restart filename
ice_in namelist input parameters
iced_gx1_v4.0_kcatbound0 restart file used for initial condition
cice/input_templates/gx3/
global_gx3.grid 3.6 x 1.85 deg displaced pole grid, 'gx3'
global_gx3.kmt 3.6 x 1.85 deg land mask (N pole is in Greenland)
ice.restart_file pointer with restart filename
ice_in namelist input parameters
iced_gx3_v4.0_kcatbound0 restart file used for initial condition
cice/input_templates/col/
ice_in namelist input parameters for column configuration
cice/mpi/ modules that require MPI calls
ice_boundary.F90 boundary conditions
ice_broadcast.F90 routines for broadcasting data across processors
ice_communicate.F90 routines for communicating between processors
ice_exit.F90 aborts or exits the run
ice_gather_scatter.F90 gather/scatters data to/from one processor from/to
all processors
ice_global_reductions.F90 global sums, minvals, etc., across processors
ice_timers.F90 timing routines
cice/serial same modules as in mpi/ but without MPI calls
cice/source/ general CICE source code
ice_age.F90 handles most work associated with age tracer
ice_atmo.F90 transfer coefficients and atmo fluxes
ice_blocks.F90 for decomposing global domain into blocks
ice_calendar.F90 keeps track of what time it is
ice_diagnostics.F90 miscellaneous diagnostic and debugging routines
ice_distribution.F90 for distributing blocks across processors
ice_domain.F90 decompositions, distributions and other info
ice_domain_size.F90 domain and block sizes
ice_dyn_evp.F90 EVP ice dynamics component
ice_fileunits.F90 unit numbers for I/O
ice_flux.F90 fluxes needed/produced by the model
ice_forcing.F90 routines to read input data for stand-alone runs
ice_grid.F90 grid and land masks
ice_history.F90 writes binary or netCDF output to history files
ice_init.F90 initializations
ice_itd.F90 routines for managing ice thickness distribution
ice_kinds_mod.F90 basic definitions of reals, integers, etc.
ice_lvl.F90 handles most work associated with level ice tracers
ice_mechred.F90 mechanical redistribution (ridging) routines
ice_meltpond.F90 meltpond parameterization
ice_ocean.F90 mixed layer routines
ice_orbital.F90 orbital parameters for delta-Eddington parameterization
ice_read_write.F90 utilities for reading and writing files
ice_restart.F90 read/write core restart file
ice_restoring.F90 basic restoring for open boundary conditions
ice_shortwave.F90 shortwave and albedo parameterizations
ice_spacecurve.F90 space-filling-curves distribution method
ice_state.F90 essential arrays to describe the state of the ice
ice_therm_itd.F90 thermodynamics related to ice thickness distribution
ice_therm_vertical.F90 vertical growth rates and fluxes
ice_timers.F90 timing routines
ice_transport_driver.F90 driver for horizontal advection
ice_transport_remap.F90 horizontal advection via incremental remapping
ice_work.F90 globally accessible work arrays
--- directories and files created when the code is compiled ---
rundir/ execution or "run" directory
cice code executable
grid horizontal grid file from cice/input_templates/gx3/
ice.log.[timeID] diagnostic output files
ice_in namelist input file from cice/input_templates/gx3/
kmt land mask file from cice/input_templates/gx3/
run_ice batch run script from cice/input_templates/gx3/
rundir/compile/ directory containing object files, etc.
rundir/hist/ directory containing history output
iceh_mavg.[timeID].nc monthly average output history file
rundir/restart/ restart directory
iced_gx3_v3.1 initial condition from cice/input_templates/gx3/
ice.restart_file restart pointer from cice/input_templates/gx3/
--- Authors ---
Elizabeth Hunke
Bill Lipscomb
and many others, greatly appreciated.
Please report any bugs to Elizabeth Hunke ([email protected])
Good luck!