API Reference#
World module#
- World module
WorldWorld.addrWorld.containerWorld.distributed_roleWorld.export_csv_pathWorld.dbWorld.market_operatorsWorld.marketsWorld.unit_operatorsWorld.unit_typesWorld.bidding_strategiesWorld.clearing_mechanismsWorld.addressesWorld.loopWorld.clockWorld.startWorld.endWorld.learning_configWorld.perform_evaluationWorld.forecasterWorld.learning_modeWorld.output_agent_addrWorld.bidding_paramsWorld.indexWorld.add_market()World.add_market_operator()World.add_rl_unit_operator()World.add_unit()World.add_unit_operator()World.add_units_with_operator_subprocess()World.async_add_unit()World.async_run()World.create_unit()World.reset()World.run()World.setup()World.setup_learning()World.setup_output_agent()
Market classes#
- Market Classes
- Subpackages
- Submodules
- assume.markets.base_market module
MarketMechanismMarketRoleMarketRole.clear_market()MarketRole.handle_data_request()MarketRole.handle_get_unmatched()MarketRole.handle_orderbook()MarketRole.handle_registration()MarketRole.latitudeMarketRole.longitudeMarketRole.marketconfigMarketRole.opening()MarketRole.registered_agentsMarketRole.required_fieldsMarketRole.setup()MarketRole.store_market_results()MarketRole.store_order_book()
- Module contents
Units#
- Units
- Submodules
- assume.units.demand module
- assume.units.powerplant module
- assume.units.storage module
StorageStorage.as_dict()Storage.calculate_marginal_cost()Storage.calculate_min_max_charge()Storage.calculate_min_max_discharge()Storage.calculate_ramp_charge()Storage.calculate_ramp_discharge()Storage.calculate_soc_max_charge()Storage.calculate_soc_max_discharge()Storage.execute_current_dispatch()Storage.get_starting_costs()Storage.set_dispatch_plan()
- Module contents
Scenario loaders#
Bidding strategies#
- Bidding strategies
- Submodules
- assume.strategies.advanced_orders module
- assume.strategies.dmas_powerplant module
- assume.strategies.dmas_storage module
- assume.strategies.extended module
- assume.strategies.flexable module
- assume.strategies.flexable_storage module
- assume.strategies.learning_advanced_orders module
RLAdvancedOrderStrategyRLAdvancedOrderStrategy.foresightRLAdvancedOrderStrategy.max_bid_priceRLAdvancedOrderStrategy.max_demandRLAdvancedOrderStrategy.deviceRLAdvancedOrderStrategy.float_typeRLAdvancedOrderStrategy.learning_modeRLAdvancedOrderStrategy.algorithmRLAdvancedOrderStrategy.actor_architecture_classRLAdvancedOrderStrategy.actorRLAdvancedOrderStrategy.order_typesRLAdvancedOrderStrategy.episodes_collecting_initial_experienceRLAdvancedOrderStrategy.calculate_bids()RLAdvancedOrderStrategy.calculate_reward()RLAdvancedOrderStrategy.create_observation()
- assume.strategies.learning_strategies module
RLStrategyRLStrategy.foresightRLStrategy.max_bid_priceRLStrategy.max_demandRLStrategy.deviceRLStrategy.float_typeRLStrategy.learning_modeRLStrategy.algorithmRLStrategy.actor_architecture_classRLStrategy.actorRLStrategy.order_typesRLStrategy.action_noiseRLStrategy.collect_initial_experience_modeRLStrategy.calculate_bids()RLStrategy.calculate_reward()RLStrategy.create_observation()RLStrategy.get_actions()RLStrategy.load_actor_params()
- assume.strategies.naive_strategies module
- Module contents
Reinforcement learning algorithms#
- Reinforcement learning algorithms
- Submodules
- assume.reinforcement_learning.buffer module
- assume.reinforcement_learning.learning_role module
LearningLearning.compare_and_save_policies()Learning.create_learning_algorithm()Learning.get_inter_episodic_data()Learning.get_noise_scale()Learning.initialize_policy()Learning.load_inter_episodic_data()Learning.save_buffer_and_update()Learning.set_noise_scale()Learning.setup()Learning.turn_off_initial_exploration()Learning.update_policy()
- assume.reinforcement_learning.learning_utils module
- assume.reinforcement_learning.algorithms.base_algorithm module
- assume.reinforcement_learning.algorithms.matd3 module
- Module contents
Common components and methods#
- Common components and methods
- Submodules
- assume.common.base module
BaseStrategyBaseUnitBaseUnit.idBaseUnit.unit_operatorBaseUnit.technologyBaseUnit.bidding_strategiesBaseUnit.indexBaseUnit.nodeBaseUnit.forecasterBaseUnit.as_dict()BaseUnit.calculate_bids()BaseUnit.calculate_cashflow()BaseUnit.calculate_generation_cost()BaseUnit.calculate_marginal_cost()BaseUnit.execute_current_dispatch()BaseUnit.get_output_before()BaseUnit.get_starting_costs()BaseUnit.reset_saved_rl_data()BaseUnit.set_dispatch_plan()
LearningConfigLearningConfig.actor_architectureLearningConfig.algorithmLearningConfig.batch_sizeLearningConfig.continue_learningLearningConfig.deviceLearningConfig.early_stopping_stepsLearningConfig.early_stopping_thresholdLearningConfig.episodes_collecting_initial_experienceLearningConfig.gammaLearningConfig.gradient_stepsLearningConfig.learning_modeLearningConfig.learning_rateLearningConfig.max_bid_priceLearningConfig.noise_dtLearningConfig.noise_scaleLearningConfig.noise_sigmaLearningConfig.train_freqLearningConfig.trained_policies_save_pathLearningConfig.training_episodes
LearningStrategySupportsMinMaxSupportsMinMax.calculate_min_max_power()SupportsMinMax.calculate_ramp()SupportsMinMax.efficiencySupportsMinMax.emission_factorSupportsMinMax.get_average_operation_times()SupportsMinMax.get_clean_spread()SupportsMinMax.get_operation_time()SupportsMinMax.get_starting_costs()SupportsMinMax.max_powerSupportsMinMax.min_down_timeSupportsMinMax.min_operating_timeSupportsMinMax.min_powerSupportsMinMax.ramp_downSupportsMinMax.ramp_up
SupportsMinMaxChargeSupportsMinMaxCharge.calculate_min_max_charge()SupportsMinMaxCharge.calculate_min_max_discharge()SupportsMinMaxCharge.calculate_ramp_charge()SupportsMinMaxCharge.calculate_ramp_discharge()SupportsMinMaxCharge.efficiency_chargeSupportsMinMaxCharge.efficiency_dischargeSupportsMinMaxCharge.get_clean_spread()SupportsMinMaxCharge.get_soc_before()SupportsMinMaxCharge.initial_socSupportsMinMaxCharge.max_power_chargeSupportsMinMaxCharge.max_power_dischargeSupportsMinMaxCharge.max_volumeSupportsMinMaxCharge.min_power_chargeSupportsMinMaxCharge.min_power_dischargeSupportsMinMaxCharge.ramp_down_chargeSupportsMinMaxCharge.ramp_down_dischargeSupportsMinMaxCharge.ramp_up_chargeSupportsMinMaxCharge.ramp_up_discharge
- assume.common.exceptions module
- assume.common.forecasts module
CsvForecasterCsvForecaster.indexCsvForecaster.powerplants_unitsCsvForecaster.calc_forecast_if_needed()CsvForecaster.calculate_marginal_cost()CsvForecaster.calculate_market_price_forecast()CsvForecaster.calculate_residual_load_forecast()CsvForecaster.get_registered_market_participants()CsvForecaster.save_forecasts()CsvForecaster.set_forecast()
ForecasterNaiveForecastRandomForecaster
- assume.common.mango_serializer module
- assume.common.market_objects module
ClearingMessageDataRequestMessageMarketConfigMarketConfig.additional_fieldsMarketConfig.addrMarketConfig.aidMarketConfig.eligible_obligations_lambda()MarketConfig.market_idMarketConfig.market_mechanismMarketConfig.market_productsMarketConfig.maximum_bid_priceMarketConfig.maximum_bid_volumeMarketConfig.maximum_gradientMarketConfig.minimum_bid_priceMarketConfig.opening_durationMarketConfig.opening_hoursMarketConfig.param_dictMarketConfig.price_tickMarketConfig.price_unitMarketConfig.product_typeMarketConfig.supports_get_unmatchedMarketConfig.volume_tickMarketConfig.volume_unit
MarketProductMetaDictOnlyHoursOpeningMessageOrderOrderBookMessageProductRegistrationMessageRegistrationReplyMessage
- assume.common.outputs module
OutputDefWriteOutputWriteOutput.check_columns()WriteOutput.del_similar_runs()WriteOutput.delete_db_scenario()WriteOutput.get_sum_reward()WriteOutput.handle_message()WriteOutput.on_stop()WriteOutput.setup()WriteOutput.store_dfs()WriteOutput.store_grid()WriteOutput.write_market_dispatch()WriteOutput.write_market_orders()WriteOutput.write_market_results()WriteOutput.write_rl_params()WriteOutput.write_unit_dispatch()WriteOutput.write_units_definition()
- assume.common.units_operator module
UnitsOperatorUnitsOperator.available_marketsUnitsOperator.registered_marketsUnitsOperator.last_sent_dispatchUnitsOperator.use_portfolio_optUnitsOperator.portfolio_strategyUnitsOperator.valid_ordersUnitsOperator.unitsUnitsOperator.idUnitsOperator.contextUnitsOperator.add_unit()UnitsOperator.formulate_bids()UnitsOperator.formulate_bids_portfolio()UnitsOperator.get_actual_dispatch()UnitsOperator.handle_data_request()UnitsOperator.handle_market_feedback()UnitsOperator.handle_opening()UnitsOperator.handle_registration_feedback()UnitsOperator.participate()UnitsOperator.register_market()UnitsOperator.set_unit_dispatch()UnitsOperator.setup()UnitsOperator.submit_bids()UnitsOperator.write_actual_dispatch()
- assume.common.utils module
adjust_unit_operator_for_learning()aggregate_step_amount()check_for_tensors()convert_to_rrule_freq()create_incidence_matrix()create_rrule()datetime2timestamp()get_available_products()get_products_index()get_test_demand_orders()initializer()normalize_availability()plot_orderbook()rename_study_case()separate_orders()timestamp2datetime()visualize_orderbook()
- assume.common.grid_utils module
- Module contents