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

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

hobart testing and report making

File size: 8.4 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 the Tasmania: %s' %scenario_name.title()
72
73# WA DLI data
74production_dirs = {'20061004_230438': 'Mw 8-7', # 7500 res
75                   '20061006_062319': 'Mw 8-5'} # 2500 res
76
77max_maps = {'Mw 8-7': 'mw87_map',
78            'Mw 8-5': 'mw85_map'}
79
80gauge_map = 'hobart_gauge.jpg'
81
82# Create sections and graphs for each designated production directory
83latex_output = []
84swwfiles = {}
85for label_id in production_dirs.keys():
86   
87    file_loc = project.outputdir + label_id + sep
88    swwfile = file_loc + project.basename + '.sww'
89    swwfiles[swwfile] = label_id
90
91texname, elev_output = sww2timeseries(swwfiles,
92                                      project.gauge_filename,
93                                      production_dirs,
94                                      report = True,
95                                      reportname = 'latexoutput',
96                                      plot_quantity = ['stage', 'speed'],
97                                      surface = False,
98                                      time_min = None,
99                                      time_max = None,
100                                      title_on = False,
101                                      verbose = True)
102
103latex_output.append(texname)
104
105# Start report generation
106# Future: generate_report(reportdir, scenario, report_title,
107# project.gauge_filename, max_maps, damage_maps, production_dirs, latex_output)
108report_name = reportdir + scenario + '_report.tex'
109fid = open(report_name, 'w')
110
111s = """
112% This is based on an automatically generated file (by make_report.py).
113%
114% Manual parts are:
115% * an abstract must be written in abstract.tex
116% * an introduction must be written in introduction.tex; a basic outline and
117%   some of the core inputs are already in place
118% * outline of the modelling methodology provided in modelling_methodology.tex
119% * the tsunami-genic event should be discussed in tsunami_scenario.tex
120% * an computational_setup.tex file needs to be written for the particular scenario
121% * the interpretation of the results needs to be written to interpretation.tex
122% * maximum inundation maps need to be included in HAT_map.tex and LAT_map.tex etc.
123% * damage modelling maps need to be included in HAT_damage and LAT_damage etc.
124% * a summary must be written into summary.tex
125% * metadata for the scenario data to be included in metadata.tex
126
127\documentclass{article}
128
129\usepackage{ae} % or {zefonts}
130\usepackage[T1]{fontenc}
131\usepackage[ansinew]{inputenc}
132\usepackage{amsmath}
133\usepackage{amssymb}
134\usepackage{graphicx}
135\usepackage{color}
136\usepackage[colorlinks]{hyperref}
137\usepackage{lscape} %landcape pages support
138\usepackage{setspace}
139\usepackage{rotating}
140\include{appendix}
141\setstretch{1.25}
142\\topmargin 0pt
143\oddsidemargin 0pt
144\evensidemargin 0pt
145\marginparwidth 0.5pt
146\\textwidth \paperwidth
147\\advance\\textwidth -2in
148
149"""
150fid.write(s)
151
152#s = '\\title{%s} \n' %report_title
153#fid.write(s)
154
155s = """
156\date{\\today}
157%\\author{Geoscience Australia}
158
159\\begin{document}
160\\title{
161\\begin{figure}[hbt]
162  \centerline{ \includegraphics[scale=0.4]{../report_figures/GAlogo.jpg}}
163\end{figure}
164"""
165fid.write(s)
166s = '%s} '%report_title
167fid.write(s)
168s = """
169  \maketitle
170
171    \section{Executive Summary}
172    \label{sec:execsum}
173  \input{execsum}
174
175  \\tableofcontents
176 
177  \section{Introduction}
178    \label{sec:intro}
179  \input{introduction}
180
181   \section{Modelling methodology}
182    \label{sec:methodology}
183    \input{modelling_methodology}
184   
185  %\section{Tsunami scenarios}
186  %  \label{sec:tsunamiscenario}
187  %  \input{tsunami_scenario}
188
189  \section{Data sources}
190    \label{sec:data}
191    \input{data}
192   
193   \section{Inundation model}
194    \label{sec:anuga}
195    \input{anuga}
196    \input{computational_setup}
197       
198  \section{Inundation modelling results}
199     \label{sec:results}
200         
201"""
202fid.write(s)
203
204# Generate latex output for location points
205s = '\\begin{table} \\begin{center} \n'
206fid.write(s)
207s = '\caption{Defined point locations for %s study area.}' %scenario_name
208fid.write(s)
209s = """
210\label{table:locations}
211\\begin{tabular}{|l|l|l|l|}\hline
212\\bf{Point Name} & \\bf{Easting} & \\bf{Northing} & \\bf{Elevation}\\\\ \hline
213"""
214fid.write(s)
215
216gauges, locations, elevation = get_gauges_from_file(project.gauge_filename)
217
218for name, gauges, elev in zip(locations, gauges, elevation):
219    east = gauges[0]
220    north = gauges[1]
221    s = '%s & %.2f & %.2f & %.2f \\\\ \hline \n' %(name.replace('_',' '), east, north, elev)
222    fid.write(s)
223
224s = '\\end{tabular} \n  \end{center} \n \end{table} \n \n'
225fid.write(s)
226
227s = '\\begin{figure}[hbt] \n \centerline{ \includegraphics[width=\paperwidth]{../report_figures/%s}}' %gauge_map
228fid.write(s)
229
230= """
231\caption{Point locations used for Hobart study.} 
232\label{fig:points}
233\end{figure}
234"""
235fid.write(s)
236   
237s = '\input{interpretation} \n'
238fid.write(s)
239
240# Assign titles to each production section
241# Must specify one name per section
242for i, name in enumerate(production_dirs.keys()):
243#
244#    s = '\subsection{%s} \n \n' %production_dirs[name]     
245#    fid.write(s)
246
247    s = '\input{%s} \n \clearpage \n \n' %max_maps[production_dirs[name]]
248    fid.write(s)
249
250# Closing
251
252s = """
253   \section{Impact modelling}
254    \label{sec:impact}
255     \input{damage}
256"""
257#fid.write(s)
258
259#for i, name in enumerate(production_dirs.keys()):
260
261#    s = '\input{%s} \n \clearpage \n \n' %damage_maps[production_dirs[name]]
262#    fid.write(s)
263
264s = """
265  % \section{Impact due to data accuracy}
266  %   \input{discussion}
267  %   \label{sec:issues}
268
269     \section{Summary}
270     \label{sec:summary}
271     \input{summary}
272
273     \section{Acknowledgements}
274     \input{acknowledgements}
275     
276    \input{references}
277
278    \\appendix
279   
280   \section{Metadata}
281     \label{sec:metadata}
282     \input{metadata}
283
284\pagebreak
285
286   \section{Time series}
287     \label{sec:timeseries}
288"""
289fid.write(s)
290
291s = '\input{%s} \n \clearpage \n \n' %latex_output[0]
292fid.write(s)
293
294s="""
295
296%\pagebreak
297
298 %  \section{Damage modelling inputs}
299 %    \label{sec:damageinputs}
300 %    \input{damage_inputs}
301
302\end{document}
303"""
304fid.write(s)
Note: See TracBrowser for help on using the repository browser.