eon.statelist#

The statelist module.

Module Contents#

Classes#

StateList

The StateList class. Serves as an interface to State objects and StateList metadata.

Data#

API#

eon.statelist.logger#

‘getLogger(…)’

class eon.statelist.StateList(StateClass, initial_state=None, config: eon.config.ConfigClass = EON_CONFIG)#

The StateList class. Serves as an interface to State objects and StateList metadata.

Initialization

Check to see if state_path exists and that state zero exists. Initializes state zero when passed a initial_state only if state zero doesn’t already exist.

get_num_states()#

Returns the number of lines in the state_table file.

get_product_state(state_number, process_id)#

Returns a State object referenced by state_number and process_id.

get_state(state_number)#

Returns a state object.

load_state_table()#
save_state_table()#
append_state_table(energy)#
state_path(state_number)#

Utility function to return the compiled path of a state, whether it exists or not.