API Reference#
World module#
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.idStorage.technologyStorage.nodeStorage.max_power_chargeStorage.min_power_chargeStorage.max_power_dischargeStorage.min_power_dischargeStorage.max_volumeStorage.min_volumeStorage.efficiency_chargeStorage.efficiency_dischargeStorage.variable_cost_chargeStorage.variable_costs_dischargeStorage.emission_factorStorage.ramp_up_chargeStorage.ramp_down_chargeStorage.ramp_up_dischargeStorage.ramp_down_dischargeStorage.fixed_costStorage.hot_start_costStorage.warm_start_costStorage.cold_start_costStorage.downtime_hot_startStorage.downtime_warm_startStorage.min_operating_timeStorage.min_down_timeStorage.is_activeStorage.bidding_startegyStorage.kwargsStorage.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()
- Module contents
Bidding strategies#
- Bidding strategies
- Submodules
- assume.strategies.extended module
- assume.strategies.flexable module
- assume.strategies.flexable_storage module
- assume.strategies.learning_strategies module
- 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_actors()Learning.create_actors_and_critics()Learning.create_critics()Learning.create_learning_algorithm()Learning.extract_actors_and_critics()Learning.handle_message()Learning.load_actor_params()Learning.load_critic_params()Learning.load_obj()Learning.load_params()Learning.save_actor_params()Learning.save_critic_params()Learning.save_params()Learning.setup()Learning.turn_off_initial_exploration()Learning.update_policy()
- assume.reinforcement_learning.learning_utils module
- Module contents
Common components and methods#
- Common components and methods
- Submodules
- assume.common.base module
BaseStrategyBaseUnitLearningConfigLearningConfig.action_dimensionLearningConfig.algorithmLearningConfig.batch_sizeLearningConfig.continue_learningLearningConfig.deviceLearningConfig.episodes_collecting_initial_experienceLearningConfig.gammaLearningConfig.gradient_stepsLearningConfig.learning_modeLearningConfig.learning_rateLearningConfig.load_model_pathLearningConfig.max_bid_priceLearningConfig.noise_dtLearningConfig.noise_scaleLearningConfig.noise_sigmaLearningConfig.observation_dimensionLearningConfig.train_freqLearningConfig.trained_actors_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
- assume.common.mango_serializer module
- assume.common.market_objects module
ClearingMessageDataRequestMessageMarketConfigMarketConfig.additional_fieldsMarketConfig.addrMarketConfig.aidMarketConfig.eligible_obligations_lambda()MarketConfig.market_mechanismMarketConfig.market_productsMarketConfig.maximum_bid_priceMarketConfig.maximum_bid_volumeMarketConfig.maximum_gradientMarketConfig.minimum_bid_priceMarketConfig.nameMarketConfig.opening_durationMarketConfig.opening_hoursMarketConfig.price_tickMarketConfig.price_unitMarketConfig.product_typeMarketConfig.supports_get_unmatchedMarketConfig.volume_tickMarketConfig.volume_unit
MarketProductMetaDictOnlyHoursOpeningMessageOrderOrderBookMessageProductRegistrationMessageRegistrationReplyMessage
- assume.common.outputs module
WriteOutputWriteOutput.check_columns()WriteOutput.check_for_tensors()WriteOutput.del_similar_runs()WriteOutput.delete_db_scenario()WriteOutput.get_sum_reward()WriteOutput.handle_message()WriteOutput.on_stop()WriteOutput.setup()WriteOutput.store_dfs()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.scenario_loader module
- assume.common.units_operator module
UnitsOperatorUnitsOperator.add_unit()UnitsOperator.formulate_bids()UnitsOperator.formulate_bids_portfolio()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()UnitsOperator.write_learning_params()UnitsOperator.write_learning_to_output()UnitsOperator.write_to_learning()
- assume.common.utils module
- Module contents