dgpost autodocs

• dgpost.transform package
  • catalysis: common calculations in catalytic testing
  • electrochemistry: calculations relevant in electrochemistry
  • impedance: fitting electrochemical impedance spectra
  • rates: determining molar rates of chemical species
  • helpers: helper functions for the transform package
  • Subpackages
• dgpost.utils package
  • parse: YAML and JSON input handler
  • load: Datagram and table loading routine
  • extract: Data extraction and interpolation routine.
  • transform: Reproducible transformations made simple.
  • plot: Reproducible plots from a table.
  • save: Save a table into a file.

dgpost.main

Module containing the execution functions for dgpost.

dgpost.main.run(path)

Main API execution function. Loads the recipe from the provided path, and processes the following entries, in order:

• load,

• extract,

• transform,

• plot,

• save.

Note

When saving a table, its metadata entry will contain dgpost version information, as well as a copy of the recipe used to create the saved object.

Parameters

path (str) – Path to the job specification, passed to dgpost.utils.parse()

Returns

A tuple of the loaded datagrams and exported & transformed tables.

Return type

(datagrams, tables)

dgpost.main.run_with_arguments()

Main external execution function.

This is the function executed when dgpost is launched using the executable. It processes the --version command, sets the loglevel based on the number of -v/-q passed, and forwards the infile argument to run().