API

footings.assumption_registry

AssumptionSet	Base class representing a temporary assumption set.
AssumptionRegistry	Base class representing an assumption repository.
assumption_registry	Decorator to declare assumption registry.
def_assumption_set	Define a set withan an assumption registry.

footings.audit

AuditConfig
AuditStepConfig

footings.data_dictionary

PandasDtype	Enum container of all valid pandas data types.
data_dictionary	A decorator that creates a custom data dictionary object.
def_column	Define a column with a data dictionary.

footings.io

create_footings_json_file
create_footings_xlsx_file	Create xlsx file.
load_footings_file	Load footings generated file.
load_footings_json_file	Load footings generated json file.
load_footings_xlsx_file	Load footings generated xlsx file.

footings.jigs

create_foreach_jig

Create a ForeachJig that runs a WrappedModel or MappedModels for each item in an iterator.

footings.model

Model	The parent modeling class providing the key methods of run, audit, and visualize.
model	Turn a class into a model within the footings framework.
step	Turn a method into a step within the footings framework.
def_parameter	Define a parameter attribute under the model.
def_sensitivity	Define a sensitivity attribute under the model.
def_meta	Define a meta attribute under the model.
def_intermediate	Define an intermediate attribute under the model.
def_return	Define an intermediate attribute under the model.

footings.scenario_registry

def_attribute	Define an attribute within a scenario.
scenario_registry	Decorator to declare scenario registry.
ScenarioRegistry	Base class representing a scenario repository.

footings.testing

assert_footings_files_equal	A generic function to assert whether two footing files are equal.
assert_footings_json_files_equal	Assert whether two footing json files are equal.
assert_footings_xlsx_files_equal	Assert whether two footing xlsx files are equal.

footings.utils

dispatch_function	Transform a function into a generic dispatch function.
once	Decorator to call function once and have it be available.
get_kws	Get attributes from obj based on a passed callable.

footings.validators

equal_to

A validator that raises a ValueError if the initializer is called with a value that is not equal to the value provided.

footings.parallel_tools

Function Dispatch footings.assumption_registry.AssumptionSet