footings_test_module.DocModel

class footings_test_module.DocModel(*, param_1: int, param_2: int, sensit_1: int = 1, sensit_2: int = 2)

This is a model to test documentation.

Parameters

param_1int

This is parameter 1.

param_2int

This is parameter 2.

Sensitivities

sensit_1int

This is sensitivity 1.

sensit_2int

This is sensitivity 2.

Meta

meta_1

This is meta 1.

meta_2

This is meta 2.

Returns

return_1int

This is return 1.

return_2int

This is return 2.

Steps

1. _step_1 - Step 1 summary

2. _step_2 - Step 2 summary

Methods

audit(self, file, **kwargs)	Audit the model which returns copies of the object as it is modified across each step.
run(self[, to_step])	Runs the model and returns any returns defined.
visualize(self)	Visualize the model to get an understanding of what model attributes are used and when.

__init__(self, *, param_1: int, param_2: int, sensit_1: int = 1, sensit_2: int = 2) → None

Method generated by attrs for class DocModel.

Methods

__init__(self, *, param_1, param_2, …)	Method generated by attrs for class DocModel.
audit(self, file, **kwargs)	Audit the model which returns copies of the object as it is modified across each step.
run(self[, to_step])	Runs the model and returns any returns defined.
visualize(self)	Visualize the model to get an understanding of what model attributes are used and when.

Attributes

meta_1
meta_2
param_1
param_2
return_1
return_2
sensit_1
sensit_2

audit(self, file: str = None, **kwargs)

Audit the model which returns copies of the object as it is modified across each step.

Parameters

filestr, optional

The name of the audit output file.

kwargs

Additional key words passed to audit.

Returns

None

An audit file in specfified format (e.g., .xlsx).

run(self, to_step=None)

Runs the model and returns any returns defined.

Parameters

to_stepstr, optional

The name of the step to run model to.

visualize(self)

Visualize the model to get an understanding of what model attributes are used and when.