You're reading the documentation for a development version. For the latest released version, please have a look at v0.1.

fitpy.report module

Well-formatted presentation of the results of fitting models to datasets.

Fitting itself is a quite complicated process, and it is crucial for routine use to have the results presented in automatically generated reports that are well-formatted presentations of the results of fitting a model to a dataset. Key to a useful report is a uniform formatting with the same information always on the same place, allowing for easily comparing different fits.

class fitpy.report.LaTeXFitReporter

Bases: LaTeXReporter

LaTeX Reporter for fit results.

In addition to the functionality provided by its superclass, this reporter automatically creates an overview figure based on the dataset it gets supplied. The figure is saved using a generic name derived from the filename of the rendered report.

Examples

For convenience, a series of examples in recipe style (for details of the recipe-driven data analysis, see aspecd.tasks) is given below for how to make use of this class. The examples focus each on a single aspect.

Note

Usually, you will have set another ASpecD-derived package as default package in your recipe for processing and analysing your data. Hence, you need to provide the package name (fitpy) in the kind property, as shown in the examples.

In its simplest form, you just define a template and a filename for the resulting report.

- kind: fitpy.report
  type: LaTeXFitReporter
  properties:
    template: simplefit.tex
    filename: test_report.tex
  compile: true

Here, we make use of the simplefit.tex template. The results will be stored in test_report.tex and the LaTeX file will be compiled into a PDF document automatically (setting compile to true).

class fitpy.report.LaTeXLHSFitReporter

Bases: LaTeXFitReporter

LaTeX Reporter for fit results using LHS.

In addition to the functionality provided by its superclass, this reporter automatically extracts the statistics from the dataset supplied and creates a figure showing the robustness of the LHS approach. The figure is saved using a generic name derived from the filename of the rendered report.

Examples

For convenience, a series of examples in recipe style (for details of the recipe-driven data analysis, see aspecd.tasks) is given below for how to make use of this class. The examples focus each on a single aspect.

Note

Usually, you will have set another ASpecD-derived package as default package in your recipe for processing and analysing your data. Hence, you need to provide the package name (fitpy) in the kind property, as shown in the examples.

In its simplest form, you just define a template and a filename for the resulting report.

- kind: fitpy.report
  type: LaTeXLHSFitReporter
  properties:
    template: lhsfit.tex
    filename: test_report.tex
  compile: true

Here, we make use of the lhsfit.tex template. The results will be stored in test_report.tex and the LaTeX file will be compiled into a PDF document automatically (setting compile to true).