Skip to content

Report

AQGCoriolisReport

Bases: Report

PDF report for an AQG Coriolis measurement

Parameters:

Name Type Description Default
CoriolisAnalysis

Processed AQG Coriolis dataset.

required
**kwargs dict

Additional parameters to Report.

{}

body()

Define the content structure

coriolis_fit_plot()

info_section()

info_values()

make()

Build the entire report

plot_context()

Context manager to insert a Matplotlib figure

results_section()

row(*cell_texts)

Create a table row

save(path)

Create report and save to file

Parameters:

Name Type Description Default
path str | Path

Output path.

required

section(heading)

Create a new section

subsection(heading)

Create a new sub-section

table(widths=None, aligns=None)

Context manager to create a table

Parameters:

Name Type Description Default
widths list[float]

Column widths.

None
aligns list[str]

Column alignments.

None

text(text)

Write a simple line of text

title(title, super_title=None)

Create the title

AQGDatasetReport

Bases: Report

PDF report for an AQG dataset

Parameters:

Name Type Description Default
dataset AQGDataset

Processed AQG dataset.

required
**kwargs dict

Additional parameters to Report.

{}

adev()

atom_number()

body()

Define the content structure

corrections()

earth_tides()

full_signal()

info_section()

info_values()

make()

Build the entire report

means_10s()

means_1h()

ocean_loading()

other()

plot_context()

Context manager to insert a Matplotlib figure

polar_motion()

pressure()

results_section()

row(*cell_texts)

Create a table row

save(path)

Create report and save to file

Parameters:

Name Type Description Default
path str | Path

Output path.

required

section(heading)

Create a new section

subsection(heading)

Create a new sub-section

table(widths=None, aligns=None)

Context manager to create a table

Parameters:

Name Type Description Default
widths list[float]

Column widths.

None
aligns list[str]

Column alignments.

None

temperatures()

text(text)

Write a simple line of text

tilt()

tilt_angles()

tilt angles

title(title, super_title=None)

Create the title

AQGProtocol

Bases: Report

PDF of protocol an AQG measurement

Parameters:

Name Type Description Default
Dictionary

AQG protocol from dashboard gui.

required
**kwargs dict

Additional parameters to Report.

{}

body()

Define the content structure

general()

general_values()

make()

Build the entire report

plot_context()

Context manager to insert a Matplotlib figure

postMeasurement()

postMeasurement_values()

row(*cell_texts)

Create a table row

save(path)

Create report and save to file

Parameters:

Name Type Description Default
path str | Path

Output path.

required

section(heading)

Create a new section

setup()

setup_values()

subsection(heading)

Create a new sub-section

table(widths=None, aligns=None)

Context manager to create a table

Parameters:

Name Type Description Default
widths list[float]

Column widths.

None
aligns list[str]

Column alignments.

None

text(text)

Write a simple line of text

title(title, super_title=None)

Create the title

AQGTiltReport

Bases: Report

PDF report for an AQG tilt calibration

Parameters:

Name Type Description Default
AQGTiltAnalysis

Processed AQG tilt dataset.

required
**kwargs dict

Additional parameters to Report.

{}

body()

Define the content structure

datasets()

info_section()

info_values()

make()

Build the entire report

plot_context()

Context manager to insert a Matplotlib figure

residuals()

results_section()

row(*cell_texts)

Create a table row

save(path)

Create report and save to file

Parameters:

Name Type Description Default
path str | Path

Output path.

required

section(heading)

Create a new section

subsection(heading)

Create a new sub-section

table(widths=None, aligns=None)

Context manager to create a table

Parameters:

Name Type Description Default
widths list[float]

Column widths.

None
aligns list[str]

Column alignments.

None

text(text)

Write a simple line of text

tilt_distribution()

tilt_offset()

title(title, super_title=None)

Create the title