Skip to content

1. Classes, methods, global variables

Samuel edited this page May 30, 2021 · 1 revision

Overview of classes:

overview_classes

Table of classes, methods and global variables in ASAM

Class name Methods Variables
Market model init() exodata
step() gridareas
schedule
TSO schedule
schedule_horizon
clock
aTSO
DAM_obook
DA_marketoperator
RDM_obook
RDM_marketoperator
IDM_obook
ID_marketoperator
BEM_obook
BE_marketoperator
IBM_obook
IB_marketoperator
reports
asset_portfolio
visu
datacollector
aGridAndSystemOperator
MarketParty_dict
ExogeniousDatabase init() model
read_check_parameters() sim_task
get_DA_resload() market_rules
allocate_exo_errors() portfolios
IB_default_price() congestions
agent_strategies
forecast_errors
DA_residual_load
opportunity_costs_db
IBP_kde_pdfs
IBP_exo_prices
sim_name
output_path
solver_name
control_state_probabilities
Time init() model
get_hour() startday
get_day() startMTU
get_MTU() step_size
asset_schedules_horizon() schedule_template
calc_delivery_period_range() report_time_matrix
calc_timestamp_by_steps() report_location_time_matrix
calc_delivery_period_end()
Reports init() model
save_all_orders_per_round() gridareas
save_market_stats() all_obooks
group_statistics() prices
publish_DAM_prices() eIBP
publish_BEM_reg_state() agent_reporters
publish_IBM_prices()
publish_RDM_wm_prices()
get_system_trade()
get_system_dispatch()
get_system_cost()
get_cleared_prices()
get_all_trade_schedule()
get_all_returns()
redispatch_PI()
interdependency_indicators()
final_keyfigures()
mark_ups_analysis()
update_expected_IBP()
Visualisation init() model
step_stat_sellbuy() outputpath
show_asset_schedules() simulationname
show_trade_per_agent()
show_dispatch_per_agent()
show_return_per_agent()
show_demand_supply_IDM()
show_system_balance()
show_system_cost()
show_redispatch_PI()
show_cleared_prices()
show_redispatch_summary()
Market Party init() model
step() strategy
update_trade_schedule() assets
set_asset_constraints() money
portfolio_dispatch() accepted_red_orders
place_ID_orders() accepted_ID_orders
place_RD_orders() accepted_DA_orders
place_BE_orders() accepted_BE_orders
small_random_quantity() trade_schedule
start_stop_blocks() financial_return
opportunity_markup() PyPSA_dispatch_model
intraday_markup() ordercount
startstop markup() unchanged_position
ramp_markup()
doublescore_markup()
GridAndSystem Operator init() model
check_market_consistency() money
update_imbalances_and_returns() ordercount
determine_congestions() red_demand
redispatch_demand() red_procured
financial_return
imbalances
system_transactions
Asset init() model
calc_dispatch_constraints() assetID
get_as_dataframe() pmax
pmin
location
srmc
assetowner
ramp_limit_up
ramp_limit_down
ramp_limit_start_up
ramp_limit_shut_down
min_up_time
min_down_time
start_up_cost
shut_down_cost
schedule
constraint_df
schedule_at_redispatch_bidding
MarketOperator init() obook
model
rules
MO_intraday (MarketOperation) init() gate_opening_time
match_intraday_orders() gate_closure_time
clear_intraday()
external_DA_settlement()
MO_redispatch(MarketOperation) init() gate_opening_time
match_redispatch_orders() gate_closure_time
clear_redispatch() imbalance_threshold
PyPSA Networkmodel
MO_dayahead (MarketOperation) init() gate_opening_time
match_dayahead_orders() gate_closure_time
clear_dayahead() PyPSA Networkmodel
MO_balancing_energy (MarketOperation) determine_control_state() regulating_state
MO_imbalance(MarketOperation) Imbalance_clearing() IBP_long
Imbalance_settlement() IBP_short
cur_imbalance_settlmeent_period
Orderbook init() model
add_order_message() ob_type
delete_orders() order_column_labels
update_orders() buyorders
remove_matched_orders() sellorders
adjust_partial_match_orders() buyorders_full_step
get_obook_as_multiindex() sellorders_full_step
store_orders_per_round() cleared_sellorders
cleared_buyorders
sell_sum_volume
sell_min_price
sell_wm_price
sell_max_price
buy_sum_volume
buy_min_price
buy_wm_price
buy_max_price
cleared_sell_sum_volume
cleared_sell_min_price
cleared_sell_wm_price
cleared_sell_max_price
cleared_sell_number_trades
cleared_buy_sum_volume
cleared_buy_min_price
cleared_buy_wm_price
cleared_buy_max_price
buyorders_per_round
cleared_buyorders_per_round
sellorders_per_round
cleared_sellorders_per_round
redispatch_demand_upward
redispatch_demand_downward
OrderMessage init() order_df
consistency_check()
exclude_internal_IDtrades()
get_as_df()

Clone this wiki locally