source: anuga_work/production/dampier_2006/make_report.py @ 4477

"""
Generate report for production run

NOTE - this will only work on Windows system (as pylab not installed on unix).

Inputs:

report_title:    title to be included in tex file
production dirs: dictionary of production directories with a
                 association to that simulation run, eg high tide,
                 low tide and MSL.
                    

Outputs:

* Report generated to scenario_report.tex where the scenario relates
the name of the production directory this script is being run from.
* figures used for report stored in the report_figure directory
NOTE, this directory will need to be committed, as well as
the latex files.

The report structure is

* Executive Summary
* Introduction
* Modelling Methodology
* Tsunami scenario
* Data sources
* Inundation modelling results
* Impact modelling
* Summary
* Acknowledgements
* References
* Appendix: Metadata
* Appendix: Inundation model metadata
* Appendix: Time series outputs

Other files included in document which require manual intervention:

* an abstract must be written in abstract.tex
* an introduction must be written in introduction.tex; a basic outline and
  some of the core inputs are already in place
* the tsunami-genic event should be discussed in tsunami_scenario.tex
* a discussion of the ANUGA model is required in anuga.tex
* a computational_setup.tex file needs to be written for the particular scenario
* the interpretation of the results needs to be written to interpretation.tex
* maximum inundation map names need to be included in HAT_map and LAT_map etc.
* damage modelling map names need to be included in HAT_damage and LAT_damage etc.
* a summary must be written into summary.tex
* metadata for the scenario data to be included in metadata.tex

May, June 2006                    
"""

from os import getcwd, sep, altsep, mkdir, access, F_OK
import project
from anuga.abstract_2d_finite_volumes.util import sww2timeseries, get_gauges_from_file

# Derive scenario name
p = getcwd().split(sep)
scenario = p[-1] # Last element of absolute CWD path
scenario_name = scenario.split('_2006')[0] # Strip any text past `_2006`
test = scenario_name.split('_')
if len(test) <> 1:
    scenario_name = '%s %s' %(test[0], test[1])

# Create report directory
reportdir = getcwd()+sep+'report07'+sep
if access(reportdir,F_OK) == 0:
    mkdir (reportdir)
    
# User defined inputs
report_title = 'Tsunami impact modelling for %s' %scenario_name.title()

is_parallel = True
if is_parallel == True:
    nodes = 8
    
return_periods = [1000, 100000]

# output directories
production_dirs_1000 = {'20061116_055135_run': 'Mw 9.0'} # RP 1000 years
production_dirs_100000 = {'20061116_055135': 'Mw 8.0'} # RP 100000 years

all_prod_dirs = [production_dirs_1000, production_dirs_100000]
                          
max_maps_1000 = {'Mw 6.0': 'mw6_map'}
max_maps_100000 = {'Mw 9.0': 'mw9_map'}

all_maps = [max_maps_1000, max_maps_100000]

# gauge map names
gauge_map1 = 'dampier_gauges_1.jpg'
gauge_map2 = 'dampier_gauges_2.jpg'

# Create sections and graphs for each designated production directory
latex_output = []
report_name = 'latexoutput'

if is_parallel == True:
    
    for j, production_dirs in enumerate(all_prod_dirs):
        
        for i in range(nodes):
            print 'Sending node %d of %d' %(i,nodes)
            reportname = report_name + '%s' + 'rp%s' %(i,j)
            swwfiles = {}
            
            for label_id in production_dirs.keys():
                file_loc = project.output_dir + label_id + sep
                sww_extra = '_P%s_%s' %(i,nodes)
                swwfile = file_loc + project.scenario_name + sww_extra + '.sww'
                swwfiles[swwfile] = label_id

                texname, elev_output = sww2timeseries(swwfiles,
                                                      project.gauge_filename,
                                                      production_dirs,
                                                      report = True,
                                                      reportname = reportname,
                                                      plot_quantity = ['stage', 'speed'],
                                                      generate_fig = True,
                                                      surface = False,
                                                      time_min = None,
                                                      time_max = None,
                                                      time_unit = 'hours',
                                                      title_on = False,
                                                      use_cache = True,
                                                      verbose = True)
                
                latex_output.append(texname)
    
else:

    for i, production_dirs in enumerate(all_prod_dirs):

        swwfiles = {}
        reportname = report_name + 'rp%s' %(i)
        
        for label_id in production_dirs.keys():

            file_loc = project.output_dir + label_id + sep
            swwfile = file_loc + project.scenario_name + '.sww'
            swwfiles[swwfile] = label_id
            
        texname, elev_output = sww2timeseries(swwfiles,
                                              project.gauge_filename,
                                              production_dirs,
                                              report = True,
                                              reportname = reportname,
                                              plot_quantity = ['stage', 'speed'],
                                              generate_fig = True,
                                              surface = False,
                                              time_min = None,
                                              time_max = None,
                                              time_unit ='hours',
                                              title_on = False,
                                              use_cache = True,
                                              verbose = True)
        latex_output.append(texname)

# Start report generation
# Future: generate_report(reportdir, scenario, report_title, 
# project.gauge_filename, max_maps, damage_maps, production_dirs, latex_output)
report_name = reportdir + scenario + '_report.tex'
fid = open(report_name, 'w')

s = """
% This is based on an automatically generated file (by make_report.py).
%
% Manual parts are:
% * an abstract must be written in abstract.tex
% * an introduction must be written in introduction.tex; a basic outline and
%   some of the core inputs are already in place
% * outline of the modelling methodology provided in modelling_methodology.tex
% * the tsunami-genic event should be discussed in tsunami_scenario.tex
% * an computational_setup.tex file needs to be written for the particular scenario
% * the interpretation of the results needs to be written to interpretation.tex
% * maximum inundation maps need to be included in HAT_map.tex and LAT_map.tex etc.
% * damage modelling maps need to be included in HAT_damage and LAT_damage etc.
% * a summary must be written into summary.tex
% * metadata for the scenario data to be included in metadata.tex

\documentclass{article}

\usepackage{ae} % or {zefonts}
\usepackage[T1]{fontenc}
\usepackage[ansinew]{inputenc}
\usepackage{amsmath}
\usepackage{amssymb}
\usepackage{graphicx}
\usepackage{color}
\usepackage[colorlinks]{hyperref}
\usepackage{lscape} %landcape pages support
\usepackage{setspace}
\usepackage{rotating}
\usepackage{pdfpages}
\include{appendix}
\setstretch{1.25}
\\topmargin 0pt
\oddsidemargin 0pt
\evensidemargin 0pt
\marginparwidth 0.5pt
\\textwidth \paperwidth
\\advance\\textwidth -2in

"""
fid.write(s)

s = """
\date{\\today}
%\\author{Geoscience Australia}

\\begin{document}
\\title{
\\begin{figure}[hbt]
  \centerline{ \includegraphics[scale=0.4]{../report_figures/GAlogo.jpg}}
\end{figure}
"""
fid.write(s)
s = '%s} '%report_title
fid.write(s)

s = """
  \maketitle

    \section{Executive Summary}
    \label{sec:execsum}
  \input{execsum}

\clearpage

  \\tableofcontents
  
  \section{Introduction}
    \label{sec:intro}
  \input{introduction}

   \section{Modelling methodology}
    \label{sec:methodology}
    \input{modelling_methodology}
    
  \section{Tsunami scenarios}
    \label{sec:tsunamiscenario}
    \input{tsunami_scenario}

  \section{Data sources}
    \label{sec:data}
    \input{data}
        
  \section{Inundation modelling results}
     \label{sec:results}
         
"""
fid.write(s)
    
s = '\input{interpretation} \n'
fid.write(s)

# Assign titles to each production section 
# Must specify one name per section
for i, max_maps in enumerate(all_maps):

    s = '\subsection{Return Period: %s years} \n \n' %return_periods[i]      
    fid.write(s)

    production_dirs = all_prod_dirs[i]
    for name in enumerate(production_dirs.keys()):
        s = '\input{%s} \n \clearpage \n \n' %max_maps[production_dirs[name]]
        fid.write(s)

# Generate latex output for location points
s = '\\begin{table} \\begin{center} \n'
fid.write(s)
s = '\caption{Defined point locations for %s study area.}' %scenario_name.title()
fid.write(s)
s = """
\label{table:locations}
\\begin{tabular}{|l|l|l|l|}\hline
\\bf{Point Name} & \\bf{Easting} & \\bf{Northing} & \\bf{Elevation (m)}\\\\ \hline
"""
fid.write(s)

gauges, locations, elevation = get_gauges_from_file(project.gauge_filename)

for name, gauges, elev in zip(locations, gauges, elevation):
    east = gauges[0]
    north = gauges[1]
    s = '%s & %.2f & %.2f & %.2f \\\\ \hline \n' %(name.replace('_',' '), east, north, elev)
    fid.write(s)

s = '\\end{tabular} \n  \end{center} \n \end{table} \n \n'
fid.write(s)

#s = '\\begin{figure}[h] \n \centerline{ \includegraphics[width=\paperwidth]{../report_figures/%s}}' %gauge_map
s = '\\begin{figure}[h] \n \centerline{ \includegraphics[scale=0.7]{../report_figures/%s}}' %gauge_map
fid.write(s)

s  = """
\caption{Point locations used for Dampier study.}  
\label{fig:points}
\end{figure}

\clearpage
"""
fid.write(s)

# Closing

s = """
   \section{Impact modelling}
    \label{sec:impact}
     \input{damage}
"""
fid.write(s)

s = """
     \section{Summary}
     \label{sec:summary}
     \input{summary}

     \section{Acknowledgements}
     \input{acknowledgements}
     
    \input{references}

\clearpage

    \\appendix

    \section{ANUGA modelling parameters}
    \label{sec:anugasetup}
    \input{anuga_setup}

\clearpage

   \section{Metadata}
     \label{sec:metadata}
     \input{metadata}

\clearpage

   \section{Time series}
     \label{sec:timeseries}
     \input{timeseriesdiscussion}
     \clearpage
"""
fid.write(s)

for i in range(len(latex_output)):
    if latex_output[i] <> '':
        s = '\subsection{Return Period: %s years} \n' %return_periods[i]
        fid.write(s)
        s = '\input{%s} \n \clearpage \n \n' %latex_output[i]   
        fid.write(s)

s="""
     \section{Damage modelling inputs}
     \label{sec:damageinputs}
     \input{damage_inputs}
     
\end{document}
"""
fid.write(s)