Creating Reports with Blueprints
The Report class helps you build professional engineering reports with text, equations, tables, and figures.
Complete Example
Use the following code to create an engineering report showcasing all available elements:
from blueprints.utils.report import Report
from blueprints.codes.eurocode.en_1993_1_1_2005.chapter_6_ultimate_limit_state import formula_6_5
from blueprints.codes.eurocode.en_1992_1_1_2004.chapter_6_ultimate_limit_state import formula_6_6n
# Create report with title
report = Report(title="Steel Member Design Verification")
# --- HEADINGS (3 levels) ---
report.add_heading("Introduction")
report.add_heading("Project Background", level=2)
report.add_heading("Design Standards", level=3)
# --- PARAGRAPHS (text formatting) ---
report.add_paragraph("This report verifies the tensile capacity of a steel member.")
report.add_paragraph("All calculations follow Eurocode standards.", bold=True)
report.add_paragraph("Values shown are for demonstration purposes.", italic=True)
report.add_paragraph("Critical results are highlighted.", bold=True, italic=True)
report.add_newline()
# --- EQUATIONS (standalone and inline) ---
report.add_heading("Theoretical Background", level=2)
report.add_paragraph("The fundamental relationship for stress is:")
report.add_equation(equation=r"\sigma = \frac{F}{A}", tag="Stress Formula")
report.add_paragraph("Where ").add_equation(r"\sigma", inline=True).add_paragraph(" is stress, ")
report.add_equation(r"F", inline=True).add_paragraph(" is force, and ")
report.add_equation(r"A", inline=True).add_paragraph(" is area.")
report.add_newline(n=2)
# --- BLUEPRINTS FORMULAS (all options) ---
report.add_heading("Design Calculations")
report.add_heading("Tensile Strength Check", level=2)
unity_check = formula_6_5.Form6Dot5UnityCheckTensileStrength(n_ed=150000, n_t_rd=200000)
# Short form (result only)
report.add_paragraph("Quick result:", bold=True)
report.add_formula(unity_check, options="short")
# Complete form (full derivation)
report.add_paragraph("Full calculation:", bold=True)
report.add_formula(unity_check, options="complete")
# Without source document in tag
report.add_paragraph("Formula number only:", bold=True)
report.add_formula(unity_check, options="complete", include_source=False)
# Inline formula
report.add_paragraph("The unity check ").add_formula(unity_check, options="short", inline=True)
report.add_paragraph(" confirms the member is adequate.")
report.add_newline()
# Another formula with units
report.add_heading("Strength Reduction Factor", level=2)
strength_factor = formula_6_6n.Form6Dot6nStrengthReductionFactor(f_ck=35)
report.add_formula(strength_factor, options="complete_with_units")
# --- TABLES ---
report.add_heading("Results Summary")
report.add_table(
headers=[r"\text{Check}", r"\text{Utilization}", r"\text{Status}"],
rows=[
[r"\text{Tensile strength}", "0.750", r"\text{PASS}"],
[r"\text{Buckling}", "0.823", r"\text{PASS}"],
[r"\text{Combined}", "0.891", r"\text{PASS}"],
]
)
# --- FIGURES ---
report.add_heading("Diagrams", level=2)
report.add_figure("cross_section.png", width=0.5)
report.add_figure("stress_diagram.png", width=0.7, caption="Stress distribution along member length")
# --- LISTS (bulleted, numbered, nested) ---
report.add_heading("Conclusions")
# Bulleted list
report.add_paragraph("Key findings:", bold=True)
report.add_list([
"All unity checks passed",
"Maximum utilization: 89.1%",
"Safety margin: adequate",
], style="bulleted")
# Numbered list
report.add_paragraph("Recommended actions:", bold=True)
report.add_list([
"Verify connection details",
"Check fabrication tolerances",
"Confirm material certificates",
], style="numbered")
# Nested list
report.add_paragraph("Design verification steps:", bold=True)
report.add_list([
"Material properties",
["Yield strength", "Ultimate strength", "Elastic modulus"],
"Cross-section checks",
["Classification", "Local buckling", ["Web", "Flange"]]
], style="numbered")
# --- SPACING ---
report.add_newline(n=2)
report.add_paragraph("End of report.", italic=True)
# Get LaTeX document
latex = report.to_latex()
print(latex)
\documentclass[11pt]{article}
\usepackage{amsmath}
\usepackage{booktabs}
\usepackage{float}
\usepackage{geometry}
\usepackage{graphicx}
\usepackage{icomma}
\usepackage{setspace}
\usepackage{xcolor}
\usepackage{titlesec}
\usepackage{helvet}
\usepackage[T1]{fontenc}
\usepackage{enumitem}
\geometry{a4paper, margin=1in}
\setstretch{1.3}
\newcommand{\txt}[1]{#1}
\setlength{\parskip}{0pt}
\setlength{\abovedisplayskip}{12pt}
\setlength{\belowdisplayskip}{12pt}
\setlist{nosep}
\definecolor{blueprintblue}{RGB}{0,40,85}
\makeatletter
\renewcommand{\maketitle}{%
\begin{center}%
{\sffamily\fontsize{18}{19}\selectfont\bfseries\color{blueprintblue}\@title}%
\vspace{4pt}%
\end{center}%
}
\makeatother
\titleformat{\section}
{\sffamily\fontsize{14}{15}\selectfont\bfseries\color{blueprintblue}}
{\thesection}{1em}{}
\titlespacing*{\section}{0pt}{8pt}{4pt}
\titleformat{\subsection}
{\sffamily\fontsize{12}{13}\selectfont\bfseries\color{blueprintblue}}
{\thesubsection}{1em}{}
\titlespacing*{\subsection}{0pt}{8pt}{4pt}
\titleformat{\subsubsection}
{\sffamily\fontsize{12}{13}\selectfont\bfseries\color{blueprintblue}}
{\thesubsubsection}{1em}{}
\titlespacing*{\subsubsection}{0pt}{4pt}{0pt}
\parindent 0in
\begin{document}
\title{Steel Member Design Verification}
\date{}
\maketitle
\section{Introduction}
\subsection{Project Background}
\subsubsection{Design Standards}
\txt{This report verifies the tensile capacity of a steel member.}
\textbf{All calculations follow Eurocode standards.}
\textit{Values shown are for demonstration purposes.}
\textbf{\textit{Critical results are highlighted.}}
\newline
\subsection{Theoretical Background}
\txt{The fundamental relationship for stress is:}
\begin{equation} \sigma = \frac{F}{A} \tag{Stress Formula} \end{equation}
\txt{Where }
\txt{ $\sigma$ }
\txt{ is stress, }
\txt{ $F$ }
\txt{ is force, and }
\txt{ $A$ }
\txt{ is area.}
\newline\newline
\section{Design Calculations}
\subsection{Tensile Strength Check}
\textbf{Quick result:}
\begin{equation} CHECK \to OK \tag{EN 1993-1-1:2005 6.5} \end{equation}
\textbf{Full calculation:}
\begin{equation} CHECK \to \left( \frac{N_{Ed}}{N_{t,Rd}} \leq 1 \right) \to \left( \frac{150000.00}{200000.00} \leq 1 \right) \to \left( 0.75 \leq 1 \right) \to OK \tag{EN 1993-1-1:2005 6.5} \end{equation}
\textbf{Formula number only:}
\begin{equation} CHECK \to \left( \frac{N_{Ed}}{N_{t,Rd}} \leq 1 \right) \to \left( \frac{150000.00}{200000.00} \leq 1 \right) \to \left( 0.75 \leq 1 \right) \to OK \tag{6.5} \end{equation}
\txt{The unity check }
\txt{ $CHECK \to OK$ (EN 1993-1-1:2005 6.5) }
\txt{ confirms the member is adequate.}
\newline
\subsection{Strength Reduction Factor}
\begin{equation} \nu = 0.6 \cdot \left(1 - \frac{f_{ck}}{250}\right) = 0.6 \cdot \left(1 - \frac{35.00}{250}\right) = 0.52 \ - \tag{EN 1992-1-1:2004 6.6n} \end{equation}
\section{Results Summary}
\begin{table}[H] \centering \begin{tabular}{lll} \toprule \text{Check} & \text{Utilization} & \text{Status} \\ \midrule \text{Tensile strength} & 0.750 & \text{PASS} \\ \text{Buckling} & 0.823 & \text{PASS} \\ \text{Combined} & 0.891 & \text{PASS} \\ \bottomrule \end{tabular} \end{table}
\subsection{Diagrams}
\begin{figure}[H] \centering \includegraphics[width=0.5\textwidth]{cross_section.png} \end{figure}
\begin{figure}[H] \centering \includegraphics[width=0.7\textwidth]{stress_diagram.png} \caption{Stress distribution along member length} \end{figure}
\section{Conclusions}
\textbf{Key findings:}
\begin{itemize} \item All unity checks passed \item Maximum utilization: 89.1% \item Safety margin: adequate \end{itemize}
\textbf{Recommended actions:}
\begin{enumerate} \item Verify connection details \item Check fabrication tolerances \item Confirm material certificates \end{enumerate}
\textbf{Design verification steps:}
\begin{enumerate} \item Material properties \begin{enumerate} \item Yield strength \item Ultimate strength \item Elastic modulus \end{enumerate} \item Cross-section checks \begin{enumerate} \item Classification \item Local buckling \begin{enumerate} \item Web \item Flange \end{enumerate} \end{enumerate} \end{enumerate}
\newline\newline
\textit{End of report.}
\end{document}
Tips
- Use method chaining for cleaner code:
report.add_heading(...).add_paragraph(...).add_newline() - Use raw strings (
r"...") for LaTeX commands to avoid escape issues - Call
.to_latex()for a final Latex-formatted output - Call
.to_word()to export directly to a Word document - Call
.add_formula()on formulas from Blueprints to automatically include source and formula numbers in the tag
Quick Start
Create a report and add content using method chaining:
from blueprints.utils.report import Report
from blueprints.codes.eurocode.en_1993_1_1_2005.chapter_6_ultimate_limit_state import formula_6_5
# Create a report
report = Report(title="Steel Connection Analysis")
# Add sections and content
report.add_heading("Design Checks")
report.add_paragraph("We verify the tensile strength capacity:")
# Add a formula
formula = formula_6_5.Form6Dot5UnityCheckTensileStrength(
n_ed=150000, # Applied force (N)
n_t_rd=200000, # Resistance (N)
)
report.add_formula(formula, options="complete")
# Generate the complete LaTeX document
latex_code = report.to_latex()
print(latex_code)
\documentclass[11pt]{article}
\usepackage{amsmath}
\usepackage{booktabs}
\usepackage{float}
\usepackage{geometry}
\usepackage{graphicx}
\usepackage{icomma}
\usepackage{setspace}
\usepackage{xcolor}
\usepackage{titlesec}
\usepackage{helvet}
\usepackage[T1]{fontenc}
\usepackage{enumitem}
\geometry{a4paper, margin=1in}
\setstretch{1.3}
\newcommand{\txt}[1]{#1}
\setlength{\parskip}{0pt}
\setlength{\abovedisplayskip}{12pt}
\setlength{\belowdisplayskip}{12pt}
\setlist{nosep}
\definecolor{blueprintblue}{RGB}{0,40,85}
\makeatletter
\renewcommand{\maketitle}{%
\begin{center}%
{\sffamily\fontsize{18}{19}\selectfont\bfseries\color{blueprintblue}\@title}%
\vspace{4pt}%
\end{center}%
}
\makeatother
\titleformat{\section}
{\sffamily\fontsize{14}{15}\selectfont\bfseries\color{blueprintblue}}
{\thesection}{1em}{}
\titlespacing*{\section}{0pt}{8pt}{4pt}
\titleformat{\subsection}
{\sffamily\fontsize{12}{13}\selectfont\bfseries\color{blueprintblue}}
{\thesubsection}{1em}{}
\titlespacing*{\subsection}{0pt}{8pt}{4pt}
\titleformat{\subsubsection}
{\sffamily\fontsize{12}{13}\selectfont\bfseries\color{blueprintblue}}
{\thesubsubsection}{1em}{}
\titlespacing*{\subsubsection}{0pt}{4pt}{0pt}
\parindent 0in
\begin{document}
\title{Steel Connection Analysis}
\date{}
\maketitle
\section{Design Checks}
\txt{We verify the tensile strength capacity:}
\begin{equation} CHECK \to \left( \frac{N_{Ed}}{N_{t,Rd}} \leq 1 \right) \to \left( \frac{150000.00}{200000.00} \leq 1 \right) \to \left( 0.75 \leq 1 \right) \to OK \tag{EN 1993-1-1:2005 6.5} \end{equation}
\end{document}
Getting Your Report
Export to LaTeX
A very useful way to work with the report is to export it as a LaTeX document. You can then compile it with your favorite LaTeX editor (Overleaf, TeXShop, etc.) or command-line tool (pdflatex, xelatex, etc.).
# Save the complete LaTeX document to your local disk (ready for Overleaf or pdflatex)
report.to_latex('report.tex')
Export to Word
You can convert your report to a Word document directly in three ways:
Save to a file path:
from blueprints.utils.report import Report
# Create a report
report = Report(title="My report")
report.add_heading("Introduction")
report.add_paragraph("Some content here.")
# Save to file
report.to_word("report.docx")
Write to bytes (for in-memory processing):
from blueprints.utils.report import Report
from io import BytesIO
# Create a report
report = Report(title="My report")
report.add_heading("Introduction")
report.add_paragraph("Some content here.")
# Write to bytes (useful for web downloads, email attachments, etc.)
docx_bytes = report.to_word()
print(f"Document size: {len(docx_bytes)} bytes")
Document size: 36745 bytes
Get bytes directly (useful for streaming or email):
from blueprints.utils.report import Report
# Create a report
report = Report(title="My report")
report.add_heading("Introduction")
report.add_paragraph("Some content here.")
# Get bytes directly
docx_bytes = report.to_word()
print(f"Document size: {len(docx_bytes)} bytes")
# Now you can stream it, send as email attachment, store in database, etc.
Document size: 36745 bytes
Export to PDF
Compile your report directly to PDF using to_pdf(). This requires a LaTeX distribution with pdflatex installed on your system.
Prerequisite: LaTeX Installation
You need a LaTeX distribution that includes pdflatex. Download from:
In the case you can't install one of those locally, consider using an online LaTeX service like Overleaf to compile the LaTeX document generated by to_latex() or use the .to_word() export option and convert to PDF via Word.
Save to a file path:
from blueprints.utils.report import Report
# Create a report
report = Report(title="My report")
report.add_heading("Introduction")
report.add_paragraph("Some content here.")
# Save to PDF file
report.to_pdf("report.pdf")
Get PDF as bytes (for in-memory processing):
from blueprints.utils.report import Report
# Create a report
report = Report(title="My report")
report.add_heading("Introduction")
report.add_paragraph("Some content here.")
# Get PDF bytes directly
pdf_bytes = report.to_pdf()
print(f"PDF size: {len(pdf_bytes)} bytes")
# Now you can stream it, send as email attachment, store in database, etc.
Keep auxiliary files for debugging:
from blueprints.utils.report import Report
# Create a report
report = Report(title="My report")
report.add_heading("Introduction")
report.add_paragraph("Some content here.")
# Keep .aux, .log, .out files alongside the PDF for debugging LaTeX issues
report.to_pdf("report.pdf", cleanup=False)
Translate Your Report
Export your report in different languages using the language parameter. This works with to_latex(), to_word(), and to_pdf().
Translation Support
We use currently online (and free) translation services for this feature. We assume no liability for translation accuracy.
Currently only English ("en") is officially supported as the default. Other languages use automatic translation and may require manual review for technical accuracy.
Export to Dutch:
from blueprints.utils.report import Report
report = Report(title="Design Report")
report.add_heading("Introduction")
report.add_paragraph("This steel beam has been verified for bending.")
# Export in German
latex_dutch = report.to_latex(language="nl")
print(latex_dutch)
\documentclass[11pt]{article}
\usepackage{amsmath}
\usepackage{booktabs}
\usepackage{float}
\usepackage{geometry}
\usepackage{graphicx}
\usepackage{icomma}
\usepackage{setspace}
\usepackage{xcolor}
\usepackage{titlesec}
\usepackage{helvet}
\usepackage[T1]{fontenc}
\usepackage{enumitem}
\geometry{a4paper, margin=1in}
\setstretch{1.3}
\newcommand{\txt}[1]{#1}
\setlength{\parskip}{0pt}
\setlength{\abovedisplayskip}{12pt}
\setlength{\belowdisplayskip}{12pt}
\setlist{nosep}
\definecolor{blueprintblue}{RGB}{0,40,85}
\makeatletter
\renewcommand{\maketitle}{%
\begin{center}%
{\sffamily\fontsize{18}{19}\selectfont\bfseries\color{blueprintblue}\@title}%
\vspace{4pt}%
\end{center}%
}
\makeatother
\titleformat{\section}
{\sffamily\fontsize{14}{15}\selectfont\bfseries\color{blueprintblue}}
{\thesection}{1em}{}
\titlespacing*{\section}{0pt}{8pt}{4pt}
\titleformat{\subsection}
{\sffamily\fontsize{12}{13}\selectfont\bfseries\color{blueprintblue}}
{\thesubsection}{1em}{}
\titlespacing*{\subsection}{0pt}{8pt}{4pt}
\titleformat{\subsubsection}
{\sffamily\fontsize{12}{13}\selectfont\bfseries\color{blueprintblue}}
{\thesubsubsection}{1em}{}
\titlespacing*{\subsubsection}{0pt}{4pt}{0pt}
\parindent 0in
\begin{document}
\title{Ontwerprapport}
\date{}
\maketitle
\section{Invoering}
\txt{Deze stalen balk is gecontroleerd op buiging.}
\end{document}
Export to multiple languages:
from blueprints.utils.report import Report
report = Report(title="Analysis Results")
report.add_heading("Summary")
report.add_paragraph("All checks passed successfully.")
# Save in different languages
report.to_latex("report_en.tex", language="en") # English (default)
report.to_latex("report_nl.tex", language="nl") # Dutch
report.to_latex("report_es.tex", language="es") # Spanish
report.to_latex("report_de.tex", language="de") # German
report.to_latex("report_fr.tex", language="fr") # French
# Also works with Word and PDF
report.to_word("report_nl.docx", language="nl")
Supported languages:
Use any language code from Google Cloud Translate. Common codes:
| Code | Language |
|---|---|
en |
English (default) |
nl |
Dutch |
es |
Spanish |
de |
German |
fr |
French |
it |
Italian |
pt |
Portuguese |
pl |
Polish |
Combine Reports
Combine multiple reports into one using the + operator. This is useful for building modular reports where each chapter or section is created separately.
Basic combination:
from blueprints.utils.report import Report
# Create separate report sections
intro = Report(title="Design Report")
intro.add_heading("Introduction")
intro.add_paragraph("This report covers the structural design.")
calcs = Report()
calcs.add_heading("Calculations")
calcs.add_equation("M = F \\cdot d", tag="1")
conclusion = Report()
conclusion.add_heading("Conclusion")
conclusion.add_paragraph("All checks passed.")
# Combine into final report (title comes from the first report)
final_report = intro + calcs + conclusion
print(final_report)
============================================================
LaTeX Report: Design Report
============================================================
Sections: 3
Subsections: 0
Equations: 1
Tables: 0
Figures: 0
Lists: 0
Content size: 194 characters
============================================================
Use .to_latex() to generate the full LaTeX document,
.to_pdf() to compile to PDF (requires pdflatex),
or .to_word() to convert to a Word document.
============================================================
Modular report structure:
from blueprints.utils.report import Report
# Build chapters independently
chapter_1 = Report(title="Steel Connection Design")
chapter_1.add_heading("Chapter 1: Material Properties")
chapter_1.add_paragraph("Steel grade S355 is used throughout.")
chapter_2 = Report()
chapter_2.add_heading("Chapter 2: Load Cases")
chapter_2.add_paragraph("Three load combinations are considered.")
chapter_3 = Report()
chapter_3.add_heading("Chapter 3: Design Checks")
chapter_3.add_paragraph("Unity checks for all connections.")
annex_a = Report()
annex_a.add_heading("Annex A: Detailed Calculations")
annex_a.add_paragraph("Step-by-step calculation sheets.")
annex_b = Report()
annex_b.add_heading("Annex B: Drawings")
annex_b.add_paragraph("Some drawings.")
# Assemble the complete report
complete_report = chapter_1 + chapter_2 + chapter_3 + annex_a + annex_b
# Export the combined report
complete_report.to_latex("full_design_report.tex")
print(complete_report)
============================================================
LaTeX Report: Steel Connection Design
============================================================
Sections: 5
Subsections: 0
Equations: 0
Tables: 0
Figures: 0
Lists: 0
Content size: 366 characters
============================================================
Use .to_latex() to generate the full LaTeX document,
.to_pdf() to compile to PDF (requires pdflatex),
or .to_word() to convert to a Word document.
============================================================
Title Handling
The combined report inherits the title from the first (leftmost) report. Reports without titles can be used for chapters and annexes.
Common Tasks
Add Text
from blueprints.utils.report import Report
# Create a report
report = Report(title="My report")
report.add_paragraph("This is regular text.").add_newline()
report.add_paragraph("This is bold text.", bold=True).add_newline(n=2)
report.add_paragraph("This is italic text....", italic=True)
report.add_paragraph("This is bold and italic.", bold=True, italic=True)
print(report.to_latex())
\documentclass[11pt]{article}
\usepackage{amsmath}
\usepackage{booktabs}
\usepackage{float}
\usepackage{geometry}
\usepackage{graphicx}
\usepackage{icomma}
\usepackage{setspace}
\usepackage{xcolor}
\usepackage{titlesec}
\usepackage{helvet}
\usepackage[T1]{fontenc}
\usepackage{enumitem}
\geometry{a4paper, margin=1in}
\setstretch{1.3}
\newcommand{\txt}[1]{#1}
\setlength{\parskip}{0pt}
\setlength{\abovedisplayskip}{12pt}
\setlength{\belowdisplayskip}{12pt}
\setlist{nosep}
\definecolor{blueprintblue}{RGB}{0,40,85}
\makeatletter
\renewcommand{\maketitle}{%
\begin{center}%
{\sffamily\fontsize{18}{19}\selectfont\bfseries\color{blueprintblue}\@title}%
\vspace{4pt}%
\end{center}%
}
\makeatother
\titleformat{\section}
{\sffamily\fontsize{14}{15}\selectfont\bfseries\color{blueprintblue}}
{\thesection}{1em}{}
\titlespacing*{\section}{0pt}{8pt}{4pt}
\titleformat{\subsection}
{\sffamily\fontsize{12}{13}\selectfont\bfseries\color{blueprintblue}}
{\thesubsection}{1em}{}
\titlespacing*{\subsection}{0pt}{8pt}{4pt}
\titleformat{\subsubsection}
{\sffamily\fontsize{12}{13}\selectfont\bfseries\color{blueprintblue}}
{\thesubsubsection}{1em}{}
\titlespacing*{\subsubsection}{0pt}{4pt}{0pt}
\parindent 0in
\begin{document}
\title{My report}
\date{}
\maketitle
\txt{This is regular text.}
\newline
\textbf{This is bold text.}
\newline\newline
\textit{This is italic text....}
\textbf{\textit{This is bold and italic.}}
\end{document}
Add Sections
from blueprints.utils.report import Report
# Create a report
report = Report(title="My report")
report.add_heading("Introduction")
report.add_heading("Background", level=2)
report.add_heading("Technical Details", level=3)
print(report.to_latex())
\documentclass[11pt]{article}
\usepackage{amsmath}
\usepackage{booktabs}
\usepackage{float}
\usepackage{geometry}
\usepackage{graphicx}
\usepackage{icomma}
\usepackage{setspace}
\usepackage{xcolor}
\usepackage{titlesec}
\usepackage{helvet}
\usepackage[T1]{fontenc}
\usepackage{enumitem}
\geometry{a4paper, margin=1in}
\setstretch{1.3}
\newcommand{\txt}[1]{#1}
\setlength{\parskip}{0pt}
\setlength{\abovedisplayskip}{12pt}
\setlength{\belowdisplayskip}{12pt}
\setlist{nosep}
\definecolor{blueprintblue}{RGB}{0,40,85}
\makeatletter
\renewcommand{\maketitle}{%
\begin{center}%
{\sffamily\fontsize{18}{19}\selectfont\bfseries\color{blueprintblue}\@title}%
\vspace{4pt}%
\end{center}%
}
\makeatother
\titleformat{\section}
{\sffamily\fontsize{14}{15}\selectfont\bfseries\color{blueprintblue}}
{\thesection}{1em}{}
\titlespacing*{\section}{0pt}{8pt}{4pt}
\titleformat{\subsection}
{\sffamily\fontsize{12}{13}\selectfont\bfseries\color{blueprintblue}}
{\thesubsection}{1em}{}
\titlespacing*{\subsection}{0pt}{8pt}{4pt}
\titleformat{\subsubsection}
{\sffamily\fontsize{12}{13}\selectfont\bfseries\color{blueprintblue}}
{\thesubsubsection}{1em}{}
\titlespacing*{\subsubsection}{0pt}{4pt}{0pt}
\parindent 0in
\begin{document}
\title{My report}
\date{}
\maketitle
\section{Introduction}
\subsection{Background}
\subsubsection{Technical Details}
\end{document}
Add Equations
Standalone equation:
from blueprints.utils.report import Report
# Create a report
report = Report(title="My report")
report.add_equation(equation="a^2 + b^2 = c^2", tag="Pythagoras")
print(report.to_latex())
\documentclass[11pt]{article}
\usepackage{amsmath}
\usepackage{booktabs}
\usepackage{float}
\usepackage{geometry}
\usepackage{graphicx}
\usepackage{icomma}
\usepackage{setspace}
\usepackage{xcolor}
\usepackage{titlesec}
\usepackage{helvet}
\usepackage[T1]{fontenc}
\usepackage{enumitem}
\geometry{a4paper, margin=1in}
\setstretch{1.3}
\newcommand{\txt}[1]{#1}
\setlength{\parskip}{0pt}
\setlength{\abovedisplayskip}{12pt}
\setlength{\belowdisplayskip}{12pt}
\setlist{nosep}
\definecolor{blueprintblue}{RGB}{0,40,85}
\makeatletter
\renewcommand{\maketitle}{%
\begin{center}%
{\sffamily\fontsize{18}{19}\selectfont\bfseries\color{blueprintblue}\@title}%
\vspace{4pt}%
\end{center}%
}
\makeatother
\titleformat{\section}
{\sffamily\fontsize{14}{15}\selectfont\bfseries\color{blueprintblue}}
{\thesection}{1em}{}
\titlespacing*{\section}{0pt}{8pt}{4pt}
\titleformat{\subsection}
{\sffamily\fontsize{12}{13}\selectfont\bfseries\color{blueprintblue}}
{\thesubsection}{1em}{}
\titlespacing*{\subsection}{0pt}{8pt}{4pt}
\titleformat{\subsubsection}
{\sffamily\fontsize{12}{13}\selectfont\bfseries\color{blueprintblue}}
{\thesubsubsection}{1em}{}
\titlespacing*{\subsubsection}{0pt}{4pt}{0pt}
\parindent 0in
\begin{document}
\title{My report}
\date{}
\maketitle
\begin{equation} a^2 + b^2 = c^2 \tag{Pythagoras} \end{equation}
\end{document}
Inline equation (within text):
from blueprints.utils.report import Report
# Create a report
report = Report(title="My report")
report.add_paragraph("The resistance is ").add_equation(r"\frac{F_y \cdot A}{1.0}", inline=True).add_paragraph(" kN")
print(report.to_latex())
\documentclass[11pt]{article}
\usepackage{amsmath}
\usepackage{booktabs}
\usepackage{float}
\usepackage{geometry}
\usepackage{graphicx}
\usepackage{icomma}
\usepackage{setspace}
\usepackage{xcolor}
\usepackage{titlesec}
\usepackage{helvet}
\usepackage[T1]{fontenc}
\usepackage{enumitem}
\geometry{a4paper, margin=1in}
\setstretch{1.3}
\newcommand{\txt}[1]{#1}
\setlength{\parskip}{0pt}
\setlength{\abovedisplayskip}{12pt}
\setlength{\belowdisplayskip}{12pt}
\setlist{nosep}
\definecolor{blueprintblue}{RGB}{0,40,85}
\makeatletter
\renewcommand{\maketitle}{%
\begin{center}%
{\sffamily\fontsize{18}{19}\selectfont\bfseries\color{blueprintblue}\@title}%
\vspace{4pt}%
\end{center}%
}
\makeatother
\titleformat{\section}
{\sffamily\fontsize{14}{15}\selectfont\bfseries\color{blueprintblue}}
{\thesection}{1em}{}
\titlespacing*{\section}{0pt}{8pt}{4pt}
\titleformat{\subsection}
{\sffamily\fontsize{12}{13}\selectfont\bfseries\color{blueprintblue}}
{\thesubsection}{1em}{}
\titlespacing*{\subsection}{0pt}{8pt}{4pt}
\titleformat{\subsubsection}
{\sffamily\fontsize{12}{13}\selectfont\bfseries\color{blueprintblue}}
{\thesubsubsection}{1em}{}
\titlespacing*{\subsubsection}{0pt}{4pt}{0pt}
\parindent 0in
\begin{document}
\title{My report}
\date{}
\maketitle
\txt{The resistance is }
\txt{ $\frac{F_y \cdot A}{1.0}$ }
\txt{ kN}
\end{document}
Add Blueprints Formulas
Integrate Blueprints formulas with different levels of detail:
from blueprints.codes.eurocode.en_1992_1_1_2004.chapter_6_ultimate_limit_state import formula_6_6n
from blueprints.utils.report import Report
# Create a report
report = Report(title="My report")
formula = formula_6_6n.Form6Dot6nStrengthReductionFactor(35)
# Add with different detail levels
report.add_formula(formula, options="short") # Just result
report.add_formula(formula, options="complete") # Full derivation
report.add_formula(formula, options="complete_with_units") # With unit labels
# Control what's shown in the tag
report.add_formula(
formula,
options="complete",
include_source=False, # Hide "EN 1992-1-1:2004"
include_formula_number=True, # Show "6.6n"
)
print(report.to_latex())
\documentclass[11pt]{article}
\usepackage{amsmath}
\usepackage{booktabs}
\usepackage{float}
\usepackage{geometry}
\usepackage{graphicx}
\usepackage{icomma}
\usepackage{setspace}
\usepackage{xcolor}
\usepackage{titlesec}
\usepackage{helvet}
\usepackage[T1]{fontenc}
\usepackage{enumitem}
\geometry{a4paper, margin=1in}
\setstretch{1.3}
\newcommand{\txt}[1]{#1}
\setlength{\parskip}{0pt}
\setlength{\abovedisplayskip}{12pt}
\setlength{\belowdisplayskip}{12pt}
\setlist{nosep}
\definecolor{blueprintblue}{RGB}{0,40,85}
\makeatletter
\renewcommand{\maketitle}{%
\begin{center}%
{\sffamily\fontsize{18}{19}\selectfont\bfseries\color{blueprintblue}\@title}%
\vspace{4pt}%
\end{center}%
}
\makeatother
\titleformat{\section}
{\sffamily\fontsize{14}{15}\selectfont\bfseries\color{blueprintblue}}
{\thesection}{1em}{}
\titlespacing*{\section}{0pt}{8pt}{4pt}
\titleformat{\subsection}
{\sffamily\fontsize{12}{13}\selectfont\bfseries\color{blueprintblue}}
{\thesubsection}{1em}{}
\titlespacing*{\subsection}{0pt}{8pt}{4pt}
\titleformat{\subsubsection}
{\sffamily\fontsize{12}{13}\selectfont\bfseries\color{blueprintblue}}
{\thesubsubsection}{1em}{}
\titlespacing*{\subsubsection}{0pt}{4pt}{0pt}
\parindent 0in
\begin{document}
\title{My report}
\date{}
\maketitle
\begin{equation} \nu = 0.52 \ - \tag{EN 1992-1-1:2004 6.6n} \end{equation}
\begin{equation} \nu = 0.6 \cdot \left(1 - \frac{f_{ck}}{250}\right) = 0.6 \cdot \left(1 - \frac{35.00}{250}\right) = 0.52 \ - \tag{EN 1992-1-1:2004 6.6n} \end{equation}
\begin{equation} \nu = 0.6 \cdot \left(1 - \frac{f_{ck}}{250}\right) = 0.6 \cdot \left(1 - \frac{35.00}{250}\right) = 0.52 \ - \tag{EN 1992-1-1:2004 6.6n} \end{equation}
\begin{equation} \nu = 0.6 \cdot \left(1 - \frac{f_{ck}}{250}\right) = 0.6 \cdot \left(1 - \frac{35.00}{250}\right) = 0.52 \ - \tag{6.6n} \end{equation}
\end{document}
Add Tables
from blueprints.utils.report import Report
# Create a report
report = Report(title="My report")
report.add_table(
headers=["Check", "Utilization", "Status"],
rows=[
[r"\text{Shear capacity}", "0.588", r"\text{PASS}"],
[r"\text{Torsion capacity}", "0.925", r"\text{PASS}"],
]
)
print(report.to_latex())
\documentclass[11pt]{article}
\usepackage{amsmath}
\usepackage{booktabs}
\usepackage{float}
\usepackage{geometry}
\usepackage{graphicx}
\usepackage{icomma}
\usepackage{setspace}
\usepackage{xcolor}
\usepackage{titlesec}
\usepackage{helvet}
\usepackage[T1]{fontenc}
\usepackage{enumitem}
\geometry{a4paper, margin=1in}
\setstretch{1.3}
\newcommand{\txt}[1]{#1}
\setlength{\parskip}{0pt}
\setlength{\abovedisplayskip}{12pt}
\setlength{\belowdisplayskip}{12pt}
\setlist{nosep}
\definecolor{blueprintblue}{RGB}{0,40,85}
\makeatletter
\renewcommand{\maketitle}{%
\begin{center}%
{\sffamily\fontsize{18}{19}\selectfont\bfseries\color{blueprintblue}\@title}%
\vspace{4pt}%
\end{center}%
}
\makeatother
\titleformat{\section}
{\sffamily\fontsize{14}{15}\selectfont\bfseries\color{blueprintblue}}
{\thesection}{1em}{}
\titlespacing*{\section}{0pt}{8pt}{4pt}
\titleformat{\subsection}
{\sffamily\fontsize{12}{13}\selectfont\bfseries\color{blueprintblue}}
{\thesubsection}{1em}{}
\titlespacing*{\subsection}{0pt}{8pt}{4pt}
\titleformat{\subsubsection}
{\sffamily\fontsize{12}{13}\selectfont\bfseries\color{blueprintblue}}
{\thesubsubsection}{1em}{}
\titlespacing*{\subsubsection}{0pt}{4pt}{0pt}
\parindent 0in
\begin{document}
\title{My report}
\date{}
\maketitle
\begin{table}[H] \centering \begin{tabular}{lll} \toprule Check & Utilization & Status \\ \midrule \text{Shear capacity} & 0.588 & \text{PASS} \\ \text{Torsion capacity} & 0.925 & \text{PASS} \\ \bottomrule \end{tabular} \end{table}
\end{document}
Add Figures
from blueprints.utils.report import Report
# Create a report
report = Report(title="My report")
# Simple figure
report.add_figure("blueprints.png")
# Figure with caption
report.add_figure(image_path="beam.png", width=0.7, caption="You can add a caption to a figure.")
print(report.to_latex())
\documentclass[11pt]{article}
\usepackage{amsmath}
\usepackage{booktabs}
\usepackage{float}
\usepackage{geometry}
\usepackage{graphicx}
\usepackage{icomma}
\usepackage{setspace}
\usepackage{xcolor}
\usepackage{titlesec}
\usepackage{helvet}
\usepackage[T1]{fontenc}
\usepackage{enumitem}
\geometry{a4paper, margin=1in}
\setstretch{1.3}
\newcommand{\txt}[1]{#1}
\setlength{\parskip}{0pt}
\setlength{\abovedisplayskip}{12pt}
\setlength{\belowdisplayskip}{12pt}
\setlist{nosep}
\definecolor{blueprintblue}{RGB}{0,40,85}
\makeatletter
\renewcommand{\maketitle}{%
\begin{center}%
{\sffamily\fontsize{18}{19}\selectfont\bfseries\color{blueprintblue}\@title}%
\vspace{4pt}%
\end{center}%
}
\makeatother
\titleformat{\section}
{\sffamily\fontsize{14}{15}\selectfont\bfseries\color{blueprintblue}}
{\thesection}{1em}{}
\titlespacing*{\section}{0pt}{8pt}{4pt}
\titleformat{\subsection}
{\sffamily\fontsize{12}{13}\selectfont\bfseries\color{blueprintblue}}
{\thesubsection}{1em}{}
\titlespacing*{\subsection}{0pt}{8pt}{4pt}
\titleformat{\subsubsection}
{\sffamily\fontsize{12}{13}\selectfont\bfseries\color{blueprintblue}}
{\thesubsubsection}{1em}{}
\titlespacing*{\subsubsection}{0pt}{4pt}{0pt}
\parindent 0in
\begin{document}
\title{My report}
\date{}
\maketitle
\begin{figure}[H] \centering \includegraphics[width=0.9\textwidth]{blueprints.png} \end{figure}
\begin{figure}[H] \centering \includegraphics[width=0.7\textwidth]{beam.png} \caption{You can add a caption to a figure.} \end{figure}
\end{document}
Add Lists
from blueprints.utils.report import Report
# Create a report
report = Report(title="My report")
# Bullet list
report.add_list(["Check 1 passed", "Check 2 passed", "Check 3 failed"], style="bulleted")
# Numbered list
report.add_list(["First step: verify inputs", "Second step: run calculations", "Third step: review results"], style='numbered')
# Numbered list, nested
report.add_list(["One", ["A", "B", "C"], "Two", ["A", ["I", "II", "III"]]], style="numbered")
print(report.to_latex())
\documentclass[11pt]{article}
\usepackage{amsmath}
\usepackage{booktabs}
\usepackage{float}
\usepackage{geometry}
\usepackage{graphicx}
\usepackage{icomma}
\usepackage{setspace}
\usepackage{xcolor}
\usepackage{titlesec}
\usepackage{helvet}
\usepackage[T1]{fontenc}
\usepackage{enumitem}
\geometry{a4paper, margin=1in}
\setstretch{1.3}
\newcommand{\txt}[1]{#1}
\setlength{\parskip}{0pt}
\setlength{\abovedisplayskip}{12pt}
\setlength{\belowdisplayskip}{12pt}
\setlist{nosep}
\definecolor{blueprintblue}{RGB}{0,40,85}
\makeatletter
\renewcommand{\maketitle}{%
\begin{center}%
{\sffamily\fontsize{18}{19}\selectfont\bfseries\color{blueprintblue}\@title}%
\vspace{4pt}%
\end{center}%
}
\makeatother
\titleformat{\section}
{\sffamily\fontsize{14}{15}\selectfont\bfseries\color{blueprintblue}}
{\thesection}{1em}{}
\titlespacing*{\section}{0pt}{8pt}{4pt}
\titleformat{\subsection}
{\sffamily\fontsize{12}{13}\selectfont\bfseries\color{blueprintblue}}
{\thesubsection}{1em}{}
\titlespacing*{\subsection}{0pt}{8pt}{4pt}
\titleformat{\subsubsection}
{\sffamily\fontsize{12}{13}\selectfont\bfseries\color{blueprintblue}}
{\thesubsubsection}{1em}{}
\titlespacing*{\subsubsection}{0pt}{4pt}{0pt}
\parindent 0in
\begin{document}
\title{My report}
\date{}
\maketitle
\begin{itemize} \item Check 1 passed \item Check 2 passed \item Check 3 failed \end{itemize}
\begin{enumerate} \item First step: verify inputs \item Second step: run calculations \item Third step: review results \end{enumerate}
\begin{enumerate} \item One \begin{enumerate} \item A \item B \item C \end{enumerate} \item Two \begin{enumerate} \item A \begin{enumerate} \item I \item II \item III \end{enumerate} \end{enumerate} \end{enumerate}
\end{document}
Add Spacing
from blueprints.utils.report import Report
# Create a report
report = Report(title="My report")
report.add_newline() # Single new line
report.add_newline(n=3) # Three new lines
print(report.to_latex())
\documentclass[11pt]{article}
\usepackage{amsmath}
\usepackage{booktabs}
\usepackage{float}
\usepackage{geometry}
\usepackage{graphicx}
\usepackage{icomma}
\usepackage{setspace}
\usepackage{xcolor}
\usepackage{titlesec}
\usepackage{helvet}
\usepackage[T1]{fontenc}
\usepackage{enumitem}
\geometry{a4paper, margin=1in}
\setstretch{1.3}
\newcommand{\txt}[1]{#1}
\setlength{\parskip}{0pt}
\setlength{\abovedisplayskip}{12pt}
\setlength{\belowdisplayskip}{12pt}
\setlist{nosep}
\definecolor{blueprintblue}{RGB}{0,40,85}
\makeatletter
\renewcommand{\maketitle}{%
\begin{center}%
{\sffamily\fontsize{18}{19}\selectfont\bfseries\color{blueprintblue}\@title}%
\vspace{4pt}%
\end{center}%
}
\makeatother
\titleformat{\section}
{\sffamily\fontsize{14}{15}\selectfont\bfseries\color{blueprintblue}}
{\thesection}{1em}{}
\titlespacing*{\section}{0pt}{8pt}{4pt}
\titleformat{\subsection}
{\sffamily\fontsize{12}{13}\selectfont\bfseries\color{blueprintblue}}
{\thesubsection}{1em}{}
\titlespacing*{\subsection}{0pt}{8pt}{4pt}
\titleformat{\subsubsection}
{\sffamily\fontsize{12}{13}\selectfont\bfseries\color{blueprintblue}}
{\thesubsubsection}{1em}{}
\titlespacing*{\subsubsection}{0pt}{4pt}{0pt}
\parindent 0in
\begin{document}
\title{My report}
\date{}
\maketitle
\newline
\newline\newline\newline
\end{document}