source: anuga_work/production/hobart_2006/make_report.py @ 3763

Last change on this file since 3763 was 3763, checked in by sexton, 17 years ago

report updates

File size: 8.5 KB
Line 
1"""
2Generate report for production run
3
4Inputs:
5
6report_title:    title to be included in tex file
7production dirs: dictionary of production directories with a
8                 association to that simulation run, eg high tide,
9                 low tide and MSL.
10                   
11
12Outputs:
13
14* Report generated to scenario_report.tex where the scenario relates
15the name of the production directory this script is being run from.
16* figures used for report stored in the report_figure directory
17NOTE, this directory will need to be committed, as well as
18the latex files.
19
20The report structure is
21
22* Executive Summary
23* Introduction
24* Modelling Methodology
25* Tsunami scenario
26* Data sources
27* Inundation model
28* Inundation modelling results
29* Impact modelling
30* Summary
31* Acknowledgements
32* References
33* Appendix: Metadata
34* Appendix: Time series outputs
35
36Other files included in document which require manual intervention:
37
38* an abstract must be written in abstract.tex
39* an introduction must be written in introduction.tex; a basic outline and
40  some of the core inputs are already in place
41* the tsunami-genic event should be discussed in tsunami_scenario.tex
42* a discussion of the ANUGA model is required in anuga.tex
43* a computational_setup.tex file needs to be written for the particular scenario
44* the interpretation of the results needs to be written to interpretation.tex
45* maximum inundation map names need to be included in HAT_map and LAT_map etc.
46* damage modelling map names need to be included in HAT_damage and LAT_damage etc.
47* a summary must be written into summary.tex
48* metadata for the scenario data to be included in metadata.tex
49
50May, June 2006                   
51"""
52
53from os import getcwd, sep, altsep, mkdir, access, F_OK
54import project
55from anuga.abstract_2d_finite_volumes.util import sww2timeseries, get_gauges_from_file
56
57# Derive scenario name
58p = getcwd().split(sep)
59scenario = p[-1] # Last element of absolute CWD path
60scenario_name = scenario.split('_2006')[0] # Strip any text past `_2006`
61test = scenario_name.split('_')
62if len(test) <> 1:
63    scenario_name = '%s %s' %(test[0], test[1])
64
65# Create report directory
66reportdir = getcwd()+sep+'report'+sep
67if access(reportdir,F_OK) == 0:
68    mkdir (reportdir)
69   
70# User defined inputs
71report_title = 'Tsunami impact modelling for Tasmania: %s' %scenario_name.title()
72
73# WA DLI data
74production_dirs = {'20061008_234702': 'Mw 8-7', # 2500 res
75                   #'20061004_230438': 'Mw 8-7', # 7500 res
76                   '20061006_062319': 'Mw 8-5'} # 2500 res
77
78max_maps = {'Mw 8-7': 'mw87_map',
79            'Mw 8-5': 'mw85_map'}
80
81gauge_map = 'hobart_gauge.jpg'
82
83# Create sections and graphs for each designated production directory
84latex_output = []
85swwfiles = {}
86for label_id in production_dirs.keys():
87   
88    file_loc = project.outputdir + label_id + sep
89    swwfile = file_loc + project.basename + '.sww'
90    swwfiles[swwfile] = label_id
91
92texname, elev_output = sww2timeseries(swwfiles,
93                                      project.gauge_filename,
94                                      production_dirs,
95                                      report = True,
96                                      reportname = 'latexoutput',
97                                      plot_quantity = ['stage', 'speed'],
98                                      surface = False,
99                                      time_min = None,
100                                      time_max = None,
101                                      title_on = False,
102                                      verbose = True)
103
104latex_output.append(texname)
105
106# Start report generation
107# Future: generate_report(reportdir, scenario, report_title,
108# project.gauge_filename, max_maps, damage_maps, production_dirs, latex_output)
109report_name = reportdir + scenario + '_report.tex'
110fid = open(report_name, 'w')
111
112s = """
113% This is based on an automatically generated file (by make_report.py).
114%
115% Manual parts are:
116% * an abstract must be written in abstract.tex
117% * an introduction must be written in introduction.tex; a basic outline and
118%   some of the core inputs are already in place
119% * outline of the modelling methodology provided in modelling_methodology.tex
120% * the tsunami-genic event should be discussed in tsunami_scenario.tex
121% * an computational_setup.tex file needs to be written for the particular scenario
122% * the interpretation of the results needs to be written to interpretation.tex
123% * maximum inundation maps need to be included in HAT_map.tex and LAT_map.tex etc.
124% * damage modelling maps need to be included in HAT_damage and LAT_damage etc.
125% * a summary must be written into summary.tex
126% * metadata for the scenario data to be included in metadata.tex
127
128\documentclass{article}
129
130\usepackage{ae} % or {zefonts}
131\usepackage[T1]{fontenc}
132\usepackage[ansinew]{inputenc}
133\usepackage{amsmath}
134\usepackage{amssymb}
135\usepackage{graphicx}
136\usepackage{color}
137\usepackage[colorlinks]{hyperref}
138\usepackage{lscape} %landcape pages support
139\usepackage{setspace}
140\usepackage{rotating}
141\include{appendix}
142\setstretch{1.25}
143\\topmargin 0pt
144\oddsidemargin 0pt
145\evensidemargin 0pt
146\marginparwidth 0.5pt
147\\textwidth \paperwidth
148\\advance\\textwidth -2in
149
150"""
151fid.write(s)
152
153#s = '\\title{%s} \n' %report_title
154#fid.write(s)
155
156s = """
157\date{\\today}
158%\\author{Geoscience Australia}
159
160\\begin{document}
161\\title{
162\\begin{figure}[hbt]
163  \centerline{ \includegraphics[scale=0.4]{../report_figures/GAlogo.jpg}}
164\end{figure}
165"""
166fid.write(s)
167s = '%s} '%report_title
168fid.write(s)
169s = """
170  \maketitle
171
172    \section{Executive Summary}
173    \label{sec:execsum}
174  \input{execsum}
175
176  \\tableofcontents
177 
178  \section{Introduction}
179    \label{sec:intro}
180  \input{introduction}
181
182   \section{Modelling methodology}
183    \label{sec:methodology}
184    \input{modelling_methodology}
185   
186  %\section{Tsunami scenarios}
187  %  \label{sec:tsunamiscenario}
188  %  \input{tsunami_scenario}
189
190  \section{Data sources}
191    \label{sec:data}
192    \input{data}
193   
194   \section{Inundation model}
195    \label{sec:anuga}
196    \input{anuga}
197    \input{computational_setup}
198       
199  \section{Inundation modelling results}
200     \label{sec:results}
201         
202"""
203fid.write(s)
204
205# Generate latex output for location points
206s = '\\begin{table} \\begin{center} \n'
207fid.write(s)
208s = '\caption{Defined point locations for %s study area.}' %scenario_name
209fid.write(s)
210s = """
211\label{table:locations}
212\\begin{tabular}{|l|l|l|l|}\hline
213\\bf{Point Name} & \\bf{Easting} & \\bf{Northing} & \\bf{Elevation}\\\\ \hline
214"""
215fid.write(s)
216
217gauges, locations, elevation = get_gauges_from_file(project.gauge_filename)
218
219for name, gauges, elev in zip(locations, gauges, elevation):
220    east = gauges[0]
221    north = gauges[1]
222    s = '%s & %.2f & %.2f & %.2f \\\\ \hline \n' %(name.replace('_',' '), east, north, elev)
223    fid.write(s)
224
225s = '\\end{tabular} \n  \end{center} \n \end{table} \n \n'
226fid.write(s)
227
228s = '\\begin{figure}[hbt] \n \centerline{ \includegraphics[width=\paperwidth]{../report_figures/%s}}' %gauge_map
229fid.write(s)
230
231= """
232\caption{Point locations used for Hobart study.} 
233\label{fig:points}
234\end{figure}
235"""
236fid.write(s)
237   
238s = '\input{interpretation} \n'
239fid.write(s)
240
241# Assign titles to each production section
242# Must specify one name per section
243for i, name in enumerate(production_dirs.keys()):
244#
245#    s = '\subsection{%s} \n \n' %production_dirs[name]     
246#    fid.write(s)
247
248    s = '\input{%s} \n \clearpage \n \n' %max_maps[production_dirs[name]]
249    fid.write(s)
250
251# Closing
252
253s = """
254   \section{Impact modelling}
255    \label{sec:impact}
256     \input{damage}
257"""
258#fid.write(s)
259
260#for i, name in enumerate(production_dirs.keys()):
261
262#    s = '\input{%s} \n \clearpage \n \n' %damage_maps[production_dirs[name]]
263#    fid.write(s)
264
265s = """
266  % \section{Impact due to data accuracy}
267  %   \input{discussion}
268  %   \label{sec:issues}
269
270     \section{Summary}
271     \label{sec:summary}
272     \input{summary}
273
274     \section{Acknowledgements}
275     \input{acknowledgements}
276     
277    \input{references}
278
279    \\appendix
280   
281   \section{Metadata}
282     \label{sec:metadata}
283     \input{metadata}
284
285\pagebreak
286
287   \section{Time series}
288     \label{sec:timeseries}
289"""
290fid.write(s)
291
292s = '\input{%s} \n \clearpage \n \n' %latex_output[0]
293fid.write(s)
294
295s="""
296
297%\pagebreak
298
299 %  \section{Damage modelling inputs}
300 %    \label{sec:damageinputs}
301 %    \input{damage_inputs}
302
303\end{document}
304"""
305fid.write(s)
Note: See TracBrowser for help on using the repository browser.