engforge.eng.costs.CostModel

class CostModel(*, name=NOTHING, cost_per_item=nan, num_items=1)

Bases: Configuration, TabulationMixin

CostModel is a mixin for components or systems that reports its costs through the cost system property, which by default sums the item_cost and sub_items_cost.

item_cost is determined by calculate_item_cost() which by default uses: cost_per_item field to return the item cost, which defaults to numpy.nan if not set. Nan values are ignored and replaced with 0.

sub_items_cost system_property summarizes the costs of any component in a Slot that has a CostModel or for SlotS which CostModel.declare_cost(slot,default=numeric|CostModelInst|dict[str,float])

Method generated by attrs for class CostModel.

Methods

add_fields	Overwrite this to modify logging fields
all_categories
calculate_item_cost	override this with a parametric model related to this systems attributes and properties
change_all_log_lvl
check_ref_slot_type	recursively checks class slots for the key, and returns the slot type
class_cost_properties	returns cost_property objects from this class & subclasses
cls_all_attrs_fields
cls_all_property_keys
cls_all_property_labels
cls_compile	compiles this class, override this to compile functionality for this class
collect_all_attributes	collects all the attributes for a system
collect_comp_refs	collects all the references for the system grouped by component
collect_dynamic_refs	collects the dynamics of the systems 1.
collect_inst_attributes	collects all the attributes for a system
collect_post_update_refs	checks all methods and creates ref's to execute them later
collect_solver_refs	collects all the references for the system grouped by function and prepended with the system key
collect_update_refs	checks all methods and creates ref's to execute them later
comp_references	A cached set of recursive references to any slot component #FIXME: by instance recache on iterative component change or other signals
compile_classes	compiles all subclass functionality
copy_config_at_state	copy the system at the current state recrusively to a certain level, by default copying everything :type levels_deep: int :param levels_deep: how many levels deep to copy, -1 is all :type level: :param level: the current level, defaults to 0 if not set
cost_categories_at_term
costs_at_term	returns a dictionary of all costs at term i, with zero if the mode function returns False at that term
critical	A routine to communicate to the root of the server network that there is an issue
custom_cost	Takes class costs set, and creates a copy of the class costs, then applies the cost numeric or CostMethod in the same way but only for that instance of
debug	Writes at a low level to the log file.
default_cost	Provide a default cost for Slot items that are not CostModel's.
dict_itemized_costs
difference	a context manager that will allow you to dynamically change any information, then will change it back in a fail safe way.
error	Writes to log as a error
extract_message
filter	This acts as the interface for logging.Filter Don't overwrite this, use add_fields instead.
format_columns
get_system_input_refs	Get the references to system input based on the specified criteria.
go_through_configurations	A generator that will go through all internal configurations up to a certain level if levels_to_descend is less than 0 ie(-1) it will go down, if it 0, None, or False it will only go through this configuration
hash	hash by parm or by input_kw, only input can be hashed by lookup as system properties can create a recursive loop and should be deterministic from input
hash_numeric_with
hash_with	Generates a hash for the object's dictionary representation, updated with additional keyword arguments.
info	Writes to log but with info category, these are important typically and inform about progress of process in general
input_attrs	Lists all input attributes for class
input_fields	no attr base types, no tuples, no lists, no dicts
installSTDLogger	We only want std logging to start
internal_components	get all the internal components
internal_configurations	go through all attributes determining which are configuration objects additionally this skip any configuration that start with an underscore (private variable)
internal_references	get references to all internal attributes and values, only saving when complete cache info is requested (vs numeric only)
internal_systems	get all the internal components
internal_tabulations	get all the internal tabulations
locate
locate_ref	Pass a string of a relative var or property on this system or pass a callable to get a reference to a function.
message_with_identiy	converts to color and string via the termcolor library :type message: str :param message: a string convertable entity :type color: :param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]
msg	Writes to log.
numeric_fields	no tuples,lists, dicts, strings, or attr base types
parent_configurations_cls	returns all subclasses that are a Configuration
parse_run_kwargs	ensures correct input for simulation.
parse_simulation_input	parses the simulation input
plot_attributes	Lists all plot attributes for class
post_update	Kwargs comes from eval_kw in solver
pre_compile	an overrideable classmethod that executes when compiled, however will not execute as a subclass
print_info
resetLog	reset log
resetSystemLogs	resets log on all internal instance LoggingMixins
reset_cls_costs
set_attr
set_default_costs	set default costs if no costs are set
setattrs	sets attributes from a dictionary
signals_attributes	Lists all signals attributes for class
slack_notification
slot_refs	returns all slot references in this configuration
slots_attributes	Lists all slots attributes for class
smart_split_dataframe	splits dataframe between constant values and variants
solvers_attributes	Lists all signals attributes for class
sub_costs	gets items from CostModel's defined in a Slot attribute or in a slot default, tolerrant to nan's in cost definitions
subclasses	return all subclasses of components, including their subclasses :type out: :param out: out is to pass when the middle of a recursive operation, do not use it!
subcls_compile	reliably compiles this method even for subclasses, override this to compile functionality for subclass interfaces & mixins
sum_costs	sums costs of cost_property's in this item that are present at term=0, and by category if define as input
system_properties_classdef	Combine other parent-classes table properties into this one, in the case of subclassed system_properties
system_references	gather a list of references to attributes and
table_fields	the table attributes corresponding to
trace_attributes	Lists all trace attributes for class
transients_attributes	Lists all signals attributes for class
update	Kwargs comes from eval_kw in solver
update_dflt_costs	updates internal default slot costs if the current component doesn't exist or isn't a cost model, this is really a component method but we will use it never the less.
validate_class	A customizeable validator at the end of class creation in forge
warning	Writes to log as a warning

Attributes

anything_changed	use the on_setattr method to determine if anything changed, also assume that stat_tab could change without input changes
as_dict	returns values as they are in the class instance
attrs_fields
classname	Shorthand for the classname
combine_cost([fget, fset, fdel, doc])	this property notifies the system this is a property to be tabulated in the dataframe output.
cost_categories	returns itemized costs grouped by category
cost_properties	returns the current values of the current properties
data_dict	this is what is captured and used in each row of the dataframe / table
dataframe	Returns a pandas DataFrame based on the current context.
dataframe_constants
dataframe_variants
displayname
filename	A nice to have, good to override
future_costs([fget, fset, fdel, doc])	this property notifies the system this is a property to be tabulated in the dataframe output.
identity	A customizeable property that will be in the log by default
input_as_dict	returns values as they are in the class instance, but converts classes inputs to their input_as_dict
input_hash
item_cost([fget, fset, fdel, doc])	A thin wrapper over system_property that will be accounted by Economics Components and apply term & categorization
itemized_costs([fget, fset, fdel, doc])	this property notifies the system this is a property to be tabulated in the dataframe output.
last_context	Returns the last context
log_fmt
log_level
log_on
log_silo
logger
numeric_as_dict	recursively gets internal components numeric_as_dict as well as its own numeric values
numeric_hash
plotable_variables	Checks columns for ones that only contain numeric types or haven't been explicitly skipped
skip_plot_vars	accesses '_skip_plot_vars' if it exists, otherwise returns empty list
slack_webhook_url
sub_items_cost([fget, fset, fdel, doc])	this property notifies the system this is a property to be tabulated in the dataframe output.
system_id	returns an instance unique id based on id(self)
table_hash
table_row_dict	returns values as they would be put in a table row from this instance ignoring any sub components
unique_hash
cost_per_item
num_items
name
parent

Parameters:

• name (str)

• cost_per_item (float)

• num_items (int)

add_fields(record)

Overwrite this to modify logging fields

property anything_changed

use the on_setattr method to determine if anything changed, also assume that stat_tab could change without input changes

property as_dict

returns values as they are in the class instance

calculate_item_cost()

override this with a parametric model related to this systems attributes and properties

Return type:

float

classmethod check_ref_slot_type(sys_key)

recursively checks class slots for the key, and returns the slot type

Return type:

list

Parameters:

sys_key (str)

classmethod class_cost_properties()

returns cost_property objects from this class & subclasses

Return type:

dict

property classname

Shorthand for the classname

classmethod cls_compile()

compiles this class, override this to compile functionality for this class

classmethod collect_all_attributes()

collects all the attributes for a system

collect_comp_refs(conf=None, **kw)

collects all the references for the system grouped by component

Parameters:

conf (Configuration | None)

collect_dynamic_refs(conf=None, **kw)

collects the dynamics of the systems 1. Time.integrate 2. Dynamic Instances

Return type:

dict

Parameters:

conf (Configuration | None)

collect_inst_attributes(**kw)

collects all the attributes for a system

collect_post_update_refs(eval_kw=None, ignore=None)

checks all methods and creates ref’s to execute them later

collect_solver_refs(conf=None, check_atr_f=None, check_kw=None, check_dynamics=True, **kw)

collects all the references for the system grouped by function and prepended with the system key

Parameters:

conf (Configuration | None)

collect_update_refs(eval_kw=None, ignore=None)

checks all methods and creates ref’s to execute them later

comp_references(ignore_none_comp=True, **kw)

A cached set of recursive references to any slot component #FIXME: by instance recache on iterative component change or other signals

classmethod compile_classes()

compiles all subclass functionality

copy_config_at_state(level=None, levels_deep=-1, changed=None, **kw)

copy the system at the current state recrusively to a certain level, by default copying everything :type levels_deep: int :param levels_deep: how many levels deep to copy, -1 is all :type level: :param level: the current level, defaults to 0 if not set

Parameters:

• levels_deep (int)

• changed (dict | None)

property cost_categories

returns itemized costs grouped by category

property cost_properties: dict

returns the current values of the current properties

costs_at_term(term, test_val=True, econ=None)

returns a dictionary of all costs at term i, with zero if the mode function returns False at that term

Parameters:

• econ – the economics component to apply “end” term mode

• term (int)

Return type:

dict

critical(*args)

A routine to communicate to the root of the server network that there is an issue

custom_cost(slot_name, cost, warn_on_non_costmodel=True)

Takes class costs set, and creates a copy of the class costs, then applies the cost numeric or CostMethod in the same way but only for that instance of

Parameters:

• slot_name (str)

• cost (float | CostModel)

property data_dict

this is what is captured and used in each row of the dataframe / table

property dataframe

Returns a pandas DataFrame based on the current context.

This method checks for the presence of last_context and its dataframe attribute. If they exist, it returns the dataframe from last_context. If not, it checks for the _patch_dataframe attribute and returns it if it exists. If neither condition is met, it returns an empty DataFrame.

Returns:

A pandas DataFrame based on the current context or an empty DataFrame if no context is available.

Return type:

pandas.DataFrame

debug(*args)

Writes at a low level to the log file… usually this should be detailed messages about what exactly is going on

classmethod default_cost(slot_name, cost, warn_on_non_costmodel=True)

Provide a default cost for Slot items that are not CostModel’s. Cost is applied class wide, but can be overriden with custom_cost per instance

Parameters:

• slot_name (str)

• cost (float | CostModel)

difference(**kwargs)

a context manager that will allow you to dynamically change any information, then will change it back in a fail safe way.

with self.difference(name=’new_name’, value = new_value) as new_config:

#do stuff with config, ok to fail

you may not access any “private” variable that starts with an _ as in _whatever

difference is useful for saving slight differences in configuration in conjunction with solve you might create wrappers for eval, or implement a strategy pattern.

only attributes may be changed.

#TODO: allow recursive operation with sub comps or systems. #TODO: make a full system copy so the system can be reverted later

error(error, msg='')

Writes to log as a error

property filename

A nice to have, good to override

filter(record)

This acts as the interface for logging.Filter Don’t overwrite this, use add_fields instead.

get_system_input_refs(strings=False, numeric=True, misc=False, all=False, boolean=False, **kw)

Get the references to system input based on the specified criteria.

Parameters:

• strings – Include system properties of string type.

• numeric – Include system properties of numeric type (float, int).

• misc – Include system properties of miscellaneous type.

• all – Include all system properties regardless of type.

• boolean – Include system properties of boolean type.

• kw – Additional keyword arguments passed to recursive config loop

Returns:

A dictionary of system property references.

Return type:

dict

go_through_configurations(level=0, levels_to_descend=-1, parent_level=0, only_inst=True, **kw)

A generator that will go through all internal configurations up to a certain level if levels_to_descend is less than 0 ie(-1) it will go down, if it 0, None, or False it will only go through this configuration

Returns:

level,config

hash(*args, **input_kw)

hash by parm or by input_kw, only input can be hashed by lookup as system properties can create a recursive loop and should be deterministic from input

hash_with(**input_kw)

Generates a hash for the object’s dictionary representation, updated with additional keyword arguments. :type **input_kw: :param **input_kw: Arbitrary keyword arguments to update the object’s dictionary representation.

Returns:

The hash value of the updated dictionary.

Raises:

Any exceptions raised by deepdiff.DeepHash if hashing fails. –

property identity

A customizeable property that will be in the log by default

info(*args)

Writes to log but with info category, these are important typically and inform about progress of process in general

property input_as_dict

returns values as they are in the class instance, but converts classes inputs to their input_as_dict

classmethod input_attrs()

Lists all input attributes for class

classmethod input_fields(add_ign_types=None)

no attr base types, no tuples, no lists, no dicts

Parameters:

add_ign_types (list | None)

installSTDLogger()

We only want std logging to start

internal_components(recache=False)

get all the internal components

Return type:

dict

internal_configurations(check_config=True, use_dict=True, none_ok=False)

go through all attributes determining which are configuration objects additionally this skip any configuration that start with an underscore (private variable)

Return type:

dict

internal_references(recache=False, numeric_only=False)

get references to all internal attributes and values, only saving when complete cache info is requested (vs numeric only)

Return type:

dict

internal_systems(recache=False)

get all the internal components

Return type:

dict

internal_tabulations(recache=False)

get all the internal tabulations

Return type:

dict

property last_context

Returns the last context

classmethod locate(key, fail=True)

Return type:

type

Returns:

the class or attribute by key if its in this system class or a subcomponent. If nothing is found raise an error

locate_ref(key, fail=True, **kw)

Pass a string of a relative var or property on this system or pass a callable to get a reference to a function. If the key has a . in it the comp the lowest level component will be returned, unless a callable is passed in which case this component will be used or the comp passed in the kw will be used. :type key: :param key: the key to locate, or a callable to be used as a reference :param comp: the component to use if a callable is passed :returns: the instance assigned to this system. If the key has a . in it the comp the lowest level component will be returned

message_with_identiy(message, color=None)

converts to color and string via the termcolor library :type message: str :param message: a string convertable entity :type color: :param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

Parameters:

message (str)

msg(*args, lvl=5)

Writes to log… this should be for raw data or something… least priorty

property numeric_as_dict

recursively gets internal components numeric_as_dict as well as its own numeric values

classmethod numeric_fields()

no tuples,lists, dicts, strings, or attr base types

classmethod parent_configurations_cls()

returns all subclasses that are a Configuration

Return type:

list

parse_run_kwargs(**kwargs)

ensures correct input for simulation. :returns: first set of input for initalization, and all input dictionaries as tuple.

parse_simulation_input(**kwargs)

parses the simulation input

Parameters:

• dt – timestep in s, required for transients

• endtime – when to end the simulation

classmethod plot_attributes()

Lists all plot attributes for class

Return type:

Dict[str, Attribute]

property plotable_variables

Checks columns for ones that only contain numeric types or haven’t been explicitly skipped

post_update(parent, *args, **kwargs)

Kwargs comes from eval_kw in solver

classmethod pre_compile()

an overrideable classmethod that executes when compiled, however will not execute as a subclass

resetLog()

reset log

resetSystemLogs(reseted=None)

resets log on all internal instance LoggingMixins

set_default_costs()

set default costs if no costs are set

setattrs(dict)

sets attributes from a dictionary

classmethod signals_attributes()

Lists all signals attributes for class

Return type:

Dict[str, Attribute]

property skip_plot_vars: list

accesses ‘_skip_plot_vars’ if it exists, otherwise returns empty list

classmethod slot_refs(recache=False)

returns all slot references in this configuration

classmethod slots_attributes(attr_type=False)

Lists all slots attributes for class

Return type:

Dict[str, Attribute]

smart_split_dataframe(df=None, split_groups=0, key_f=<function <lambda>>)

splits dataframe between constant values and variants

classmethod solvers_attributes()

Lists all signals attributes for class

Return type:

Dict[str, Attribute]

sub_costs(saved=None, categories=None, term=0, econ=None)

gets items from CostModel’s defined in a Slot attribute or in a slot default, tolerrant to nan’s in cost definitions

Parameters:

• saved (set | None)

• categories (tuple | None)

classmethod subclasses(out=None)

return all subclasses of components, including their subclasses :type out: :param out: out is to pass when the middle of a recursive operation, do not use it!

classmethod subcls_compile()

reliably compiles this method even for subclasses, override this to compile functionality for subclass interfaces & mixins

sum_costs(saved=None, categories=None, term=0, econ=None)

sums costs of cost_property’s in this item that are present at term=0, and by category if define as input

Parameters:

• saved (set | None)

• categories (tuple | None)

property system_id: str

returns an instance unique id based on id(self)

classmethod system_properties_classdef(recache=False)

Combine other parent-classes table properties into this one, in the case of subclassed system_properties

system_references(recache=False, numeric_only=False, **kw)

gather a list of references to attributes and

classmethod table_fields()

the table attributes corresponding to

property table_row_dict

returns values as they would be put in a table row from this instance ignoring any sub components

classmethod trace_attributes()

Lists all trace attributes for class

Return type:

Dict[str, Attribute]

classmethod transients_attributes()

Lists all signals attributes for class

Return type:

Dict[str, Attribute]

update(parent, *args, **kwargs)

Kwargs comes from eval_kw in solver

update_dflt_costs()

updates internal default slot costs if the current component doesn’t exist or isn’t a cost model, this is really a component method but we will use it never the less.

This should be called from Component.update() if default costs are used

classmethod validate_class()

A customizeable validator at the end of class creation in forge

warning(*args)

Writes to log as a warning