dgpost.utils package

dgpost.utils.extract(obj: dict | DataFrame | DataTree | None, spec: dict, index: Index | None = None) → DataFrame

dgpost.utils.transform(table: DataFrame, withstr: str, using: list[dict]) → None

dgpost.utils.load(path: str, check: bool | None = None, type: str = 'netcdf') → dict | DataFrame

dgpost.utils.parse(fn: str) → dict[str, Any]

Input file parsing function.

Supports loading yaml and json files using the recipe-parsing function and schema provided in the dgbowl_schemas.dgpost.recipe module.

Parameters:

fn – Path to the filename to be parsed

Returns:

ret – A dictionary representing the recipe.

Return type:

dict[str, Any]

dgpost.utils.save(table: DataFrame, path: str, type: str | None = None, columns: list[str] | None = None, sigma: bool = True, meta: dict | None = None) → None

dgpost.utils.plot(table: DataFrame, ax_args: list[dict], save: dict, style: dict | None = None, fig_args: dict | None = None, **grid_args)

dgpost.utils.pivot(table: DataFrame, using: str | list[str], columns: list[str] | None = None, timestamp: str = 'first', timedelta: str | None = None) → DataFrame

Submodules

• extract: extract and interpolate data into tables
  • Extract
    • Extract.into
    • Extract.from_
    • Extract.at
    • Extract.columns
    • Extract.constants
    • Extract.check_one_input
  • get_step()
  • get_constant()
  • extract()
  • extract_obj()
• helpers: helper functions for the transform package
• element_from_formula()
• default_element()
• name_to_chem()
• columns_to_smiles()
• electrons_from_smiles()
• pQ()
• separate_data()
• load_data()
• kwarg_to_quantity()
• merge_units()
• combine_tables()
• arrow_to_multiindex()
• keys_in_df()
• key_to_tuple()
• get_units()
• set_units()
• fill_nans()
• load: load datagrams and tables
  • Load
    • Load.as_
    • Load.path
    • Load.type
    • Load.check
    • Load.check_is_deprecated
    • Load.lowercase_type
  • load()
• parse: YAML and JSON input handler
• update_recipe()
• parse()
• pivot: reorder tables using columns
  • Pivot
    • Pivot.table
    • Pivot.as_
    • Pivot.using
    • Pivot.columns
    • Pivot.timestamp
    • Pivot.timedelta
  • pivot()
• plot: create reproducible plots from tables
  • Plot
    • Plot.table
    • Plot.nrows
    • Plot.ncols
    • Plot.fig_args
    • Plot.ax_args
    • Plot.style
    • Plot.save
  • apply_plot_style()
  • plt_axes()
  • plot()
• save: save and export tables into files
  • Save
    • Save.table
    • Save.as_
    • Save.type
    • Save.columns
    • Save.sigma
  • save()
• transform: transform and calculate data in tables
  • Transform
    • Transform.table
    • Transform.with_
    • Transform.using
  • transform()