Skip to content

REPORTS.md

Latest commit

 

History

History
74 lines (50 loc) · 2.23 KB

REPORTS.md

File metadata and controls

74 lines (50 loc) · 2.23 KB

Report Generation Guide

This project now supports generating comprehensive elevator simulation reports in both Markdown and PDF formats, available in both English and Chinese.

Report Templates

We have created two comprehensive report templates:

  1. English Report: elevator_simulation_report_en.md
  2. Chinese Report: elevator_simulation_report_cn.md

These templates contain detailed sections covering:

  • Executive Summary
  • Simulation Configuration
  • Methodology
  • Results and Analysis
  • Recommendations
  • Technical Implementation Details
  • Conclusion
  • Appendices

Generating Reports

Using Gradle Task (Recommended)

To generate both English and Chinese PDF reports from the Markdown templates, run:

./gradlew generateReports

This will generate:

  • elevator_simulation_report_en.pdf (English version)
  • elevator_simulation_report_cn.pdf (Chinese version)

Manual Generation

You can also generate reports manually using the ReportGeneratorUtil class:

./gradlew run --args='generate-reports'

Report Structure

Both reports follow the same comprehensive structure to ensure all important information is captured:

  1. Executive Summary - Key findings and overall performance metrics
  2. Simulation Configuration - Detailed setup parameters
  3. Methodology - Technical approach and algorithms used
  4. Results and Analysis - Performance data with charts and tables
  5. Recommendations - Optimization suggestions based on results
  6. Technical Implementation Details - Deep dive into the features implemented
  7. Conclusion - Summary of improvements and benefits
  8. Appendices - Technical specifications and raw data

Customization

To customize the reports for a specific simulation:

  1. Modify the Markdown templates (elevator_simulation_report_en.md and elevator_simulation_report_cn.md)
  2. Replace placeholder values (marked with []) with actual simulation data
  3. Regenerate the PDF reports using the Gradle task

Dependencies

The report generation functionality uses:

  • iText 7 - For PDF generation
  • flexmark-java - For Markdown to HTML conversion
  • HTML to PDF converter - For converting HTML to PDF

These dependencies are automatically managed through Gradle.