English
 
Privacy Policy Disclaimer
  Advanced SearchBrowse

Item

ITEM ACTIONSEXPORT

Released

Software

gfzreport - a Python tool and online text editor for creating any kind of report meeting GFZ requirements in HTML and PDF format

Authors
/persons/resource/rizac

Zaccarelli,  Riccardo
2.6 Seismic Hazard and Risk Dynamics, 2.0 Geophysics, Departments, GFZ Publication Database, Deutsches GeoForschungsZentrum;

/persons/resource/pevans

Evans,  Peter
2.4 Seismology, 2.0 Geophysics, Departments, GFZ Publication Database, Deutsches GeoForschungsZentrum;

External Ressource
No external resources are shared
Fulltext (public)
There are no public fulltexts stored in GFZpublic
Supplementary Material (public)
There is no public supplementary material available
Citation

Zaccarelli, R., Evans, P.(2019): gfzreport - a Python tool and online text editor for creating any kind of report meeting GFZ requirements in HTML and PDF format, Potsdam : GFZ Data Services.
https://doi.org/10.5880/GFZ.2.6.2023.006


Cite as: https://gfzpublic.gfz-potsdam.de/pubman/item/item_5024868
Abstract
Preparation of technical reports can be unwieldy. However, a significant proportion of the document structure is often standardised. The GFZ Report Generator is a Python 2.7 application meant to ease this process by (i) automatically generating the standardised figures and tables, (ii) creating a report template pre-filled with this standard content, and which meets the GFZ style requirements, and (iii) providing a browser-based GUI with a text editor where users can add content to the report, generate and inspect the HTML and PDF versions on the fly as they are editing, track changes and revert to previous versions, and easily control the document structure and formatting from within the text by typing special characters in reStructuredText, an easy-to-read, what-you-see-is-what-you-get plaintext markup syntax. The GFZ Report Generator is quite flexible and by the use of tailor-made templates can be adapted easily to other use cases, where part of a document is based on standardised figures and section structure. For example, the software is deployed at GEOFON to generate both seismic network reports and annual reports. For the former, GEOFON also offers an online service (https://geofon.gfz-potsdam.de/waveform/reportgenerator/) where PIs and others can easily generate report templates pre-filled with network-specific content (e.g., probability density functions plots) and available online for editing. In this process, the deployed instance of the GFZ Report Generator proved to be useful for finding some classes of problems with the data and metadata stored at GEOFON.