API

datazimmer Package

sscu-budapest utilities for scientific data engineering

Functions

dump_dfs_to_tables(df_structable_pairs[, ...])	helper function to fill the detected env of a dataset
get_raw_data_path(leaf_name[, project])	if project is None, raw data output path is given, otherwise imported
parse_df(df, entity[, verbose])
register([procfun, dependencies, outputs, ...])	registers a function to the pipeline the names of parameters will matter and will be looked up in conf/envs.yaml params
register_data_loader([fun, extra_deps])	Convenience functions to use register with typical parameters
register_env_creator([fun, extra_deps])	Convenience functions to use register with typical parameters

Classes

AbstractEntity()
CompositeTypeBase()
DzAswan([global_run])
EntityClass(name, identifiers, ...)
Index()
Nullable(dtype)
PersistentState()
ReportFile(filename)
ScruTable(entity[, entity_key_table_map, ...])
SourceUrl(_)

Class Inheritance Diagram

digraph inheritance766a52bd73 { bgcolor=transparent; rankdir=LR; size="8.0, 12.0"; "AbstractEntity" [URL="api/datazimmer.AbstractEntity.html#datazimmer.AbstractEntity",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top"]; "ColAssigner" -> "AbstractEntity" [arrowsize=0.5,style="setlinewidth(0.5)"]; "ColAccessor" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",tooltip="describe and access raw columns"]; "ColAssigner" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",tooltip="define functions that create columns in a dataframe"]; "ColAccessor" -> "ColAssigner" [arrowsize=0.5,style="setlinewidth(0.5)"]; "CompositeTypeBase" [URL="api/datazimmer.CompositeTypeBase.html#datazimmer.CompositeTypeBase",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top"]; "ColAssigner" -> "CompositeTypeBase" [arrowsize=0.5,style="setlinewidth(0.5)"]; "DzAswan" [URL="api/datazimmer.DzAswan.html#datazimmer.DzAswan",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top"]; "EntityClass" [URL="api/datazimmer.EntityClass.html#datazimmer.EntityClass",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="EntityClass(name: str, identifiers: List[Union[datazimmer.metadata.atoms.PrimitiveFeature, datazimmer.metadata.atoms.CompositeFeature, datazimmer.metadata.atoms.ObjectProperty]] = <factory>, properties: List[Union[datazimmer.metadata.atoms.PrimitiveFeature, datazimmer.metadata.atoms.CompositeFeature, datazimmer.metadata.atoms.ObjectProperty]] = <factory>, parents: List[ForwardRef('EntityClass')] = <factory>, description: Optional[str] = None)"]; "_AtomBase" -> "EntityClass" [arrowsize=0.5,style="setlinewidth(0.5)"]; "Index" [URL="api/datazimmer.Index.html#datazimmer.Index",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top"]; "Nullable" [URL="api/datazimmer.Nullable.html#datazimmer.Nullable",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top"]; "PersistentState" [URL="api/datazimmer.PersistentState.html#datazimmer.PersistentState",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="PersistentState()"]; "ReportFile" [URL="api/datazimmer.ReportFile.html#datazimmer.ReportFile",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="ReportFile(filename: str)"]; "ScruTable" [URL="api/datazimmer.ScruTable.html#datazimmer.ScruTable",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top"]; "SourceUrl" [URL="api/datazimmer.SourceUrl.html#datazimmer.SourceUrl",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top"]; "_AtomBase" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled"]; }