Classes
class	InvalidCandidates

class	InvalidTrajectoryConstraint

class	InvalidTreeStructure

Public Member Functions
	__init__ (self, Path input_file)

	verify_tree_probabilities (self)

	verify_tree_investment_dates (self)

	verify_nodes_candidates_types (self)

	verify_constraint_variable_reference (self)

	verify_nodes_candidates_match_with_study (self)

	verify_candidates_span_continuous_subtree (self)

	run_all_verification (self)

	set_nodes_parents_names (self)

	compute_node_full_probability (self)

	compute_node_duration (self)

	set_all_candidates (self)

	expand_all_keyword_in_constraints (self)

	detect_fully_decommed_candidates (self)

	add_delta_costs_fully_decommed_candidate (self, dict master_merger_info)

	parse_trajectory_user_file (self)

	print (self)

	write_merger_json (self, Path output_file)

	get_root_study (self)

Public Attributes
	input_file = input_file

Set[str]	all_candidates = set()

Dict[str, Set[str]]	candidate_appears_in_nodes = dict()

Set[str]	all_nodes = set()

Optional[Tree]	tree = None

dict	nodes = {}

Optional[GlobalData]	global_data = None

dict	candidates_types_costs = {}

list	constraints = []

dict	initial_capacities = {}

Optional[GlobalData]	all_nodes = self.global_data.studies.get(node_name)

dict	all_nodes = self.nodes[node].candidate_to_type.keys()

Detailed Description

Parsing, verification and translation of  the user input data.

Member Function Documentation

◆ add_delta_costs_fully_decommed_candidate()

user_input_translation.UserInputTranslator.add_delta_costs_fully_decommed_candidate	(		self,
		dict	master_merger_info )

Given an already generated output master_merger_info dict,
We need to manually add the costs of the delta variables for the node
where a candidate is fully decommissioned and disappears from the study.

◆ compute_node_duration()

user_input_translation.UserInputTranslator.compute_node_duration ( self )

After parsing the nodes and tree, compute the node's duration
from the next investment date / end of horizon date

◆ compute_node_full_probability()

user_input_translation.UserInputTranslator.compute_node_full_probability ( self )

After parsing the tree and the node's, add the node's full probability to its data

◆ detect_fully_decommed_candidates()

user_input_translation.UserInputTranslator.detect_fully_decommed_candidates ( self )

Returns a list of pairs (candidate, node_where_candidate_disappears)
When a candidate disappears, we consider it fully decommissioned

◆ parse_trajectory_user_file()

user_input_translation.UserInputTranslator.parse_trajectory_user_file ( self )

Parse the data contained in the user's input file

◆ print()

user_input_translation.UserInputTranslator.print ( self )

Prints a summary of the data in the console.

◆ set_all_candidates()

user_input_translation.UserInputTranslator.set_all_candidates ( self )

Sets all candidates dicts and list from the parsed data.

◆ set_nodes_parents_names()

user_input_translation.UserInputTranslator.set_nodes_parents_names ( self )

After parsing the tree and the nodes, go through the tree to write each node's parent in its data

◆ verify_candidates_span_continuous_subtree()

user_input_translation.UserInputTranslator.verify_candidates_span_continuous_subtree ( self )

A candidate must appear in a continuous bit of the trajecotry tree : can only appear and eventually disappear once.

◆ verify_constraint_variable_reference()

user_input_translation.UserInputTranslator.verify_constraint_variable_reference ( self )

Verifies the the constraints reference existing variable.

The documentation for this class was generated from the following file:

src/python/antares_xpansion/trajectory/user_input_translation.py

Classes

Public Member Functions

Public Attributes