API Reference#
World module#
- World module
WorldWorld.addrWorld.distributed_roleWorld.export_csv_pathWorld.log_levelWorld.db_uriWorld.dbWorld.containerWorld.loopWorld.clockWorld.startWorld.endWorld.market_operatorsWorld.marketsWorld.unit_operatorsWorld.unit_typesWorld.dst_componentsWorld.bidding_strategiesWorld.clearing_mechanismsWorld.additional_kpisWorld.scenario_dataWorld.addressesWorld.output_agent_addrWorld.bidding_paramsWorld.indexWorld.learning_configWorld.learning_modeWorld.evaluation_modeWorld.forecasterWorld.add_market()World.add_market_operator()World.add_unit()World.add_unit_instance()World.add_unit_operator()World.add_units_with_operator_subprocess()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.on_ready()MarketRole.opening()MarketRole.registered_agentsMarketRole.required_fieldsMarketRole.setup()MarketRole.store_flows()MarketRole.store_market_results()MarketRole.store_order_book()MarketRole.validate_orderbook()MarketRole.validate_registration()
- Module contents
Units#
- Units Overview
- Submodules
- Demand Module
- Power Plant Module
- 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()
- Demand Side Technology Module
DSMFlexDSMFlex.as_dict()DSMFlex.big_MDSMFlex.calculate_marginal_cost()DSMFlex.cost_based_flexibility()DSMFlex.define_objective_opt()DSMFlex.define_sets()DSMFlex.determine_optimal_operation_with_flex()DSMFlex.determine_optimal_operation_without_flex()DSMFlex.electricity_price_signal()DSMFlex.flexibility_mapDSMFlex.grid_congestion_management()DSMFlex.initialize_components()DSMFlex.initialize_solver()DSMFlex.peak_load_shifting_flexibility()DSMFlex.renewable_utilisation()DSMFlex.setup_model()DSMFlex.switch_to_flex()DSMFlex.switch_to_opt()DSMFlex.symmetric_flexible_block()
- Demand Side Technology Components
- Module Contents
Scenario loaders#
- Scenario Loaders
- Submodules
- CSV Loader
- OEDS Loader
- OEDS Infrastructure
InfrastructureInterfaceInfrastructureInterface.aggregate_cchps()InfrastructureInterface.get_biomass_systems_in_area()InfrastructureInterface.get_co2_price()InfrastructureInterface.get_coal_price()InfrastructureInterface.get_country_demand()InfrastructureInterface.get_country_renewables()InfrastructureInterface.get_demand_in_area()InfrastructureInterface.get_demand_series_in_area()InfrastructureInterface.get_gas_price()InfrastructureInterface.get_grid_edges()InfrastructureInterface.get_grid_nodes()InfrastructureInterface.get_lat_lon()InfrastructureInterface.get_lat_lon_area()InfrastructureInterface.get_offshore_wind_series()InfrastructureInterface.get_oil_price()InfrastructureInterface.get_plz_codes()InfrastructureInterface.get_power_plant_in_area()InfrastructureInterface.get_renewables_series_in_area()InfrastructureInterface.get_run_river_systems_in_area()InfrastructureInterface.get_solar_storage_systems_in_area()InfrastructureInterface.get_solar_systems_in_area()InfrastructureInterface.get_water_storage_systems()InfrastructureInterface.get_weather_param()InfrastructureInterface.get_wind_turbines_in_area()InfrastructureInterface.set_default_params()InfrastructureInterface.setup()
get_dem_agents()get_pwp_agents()get_res_agents()get_solar_series()get_storage_agents()get_wind_series()
- AMIRIS Loader
- PyPSA Loader
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_strategies module
EnergyLearningSingleBidStrategyEnergyLearningStrategyEnergyLearningStrategy.foresightEnergyLearningStrategy.max_bid_priceEnergyLearningStrategy.max_demandEnergyLearningStrategy.deviceEnergyLearningStrategy.float_typeEnergyLearningStrategy.learning_modeEnergyLearningStrategy.algorithmEnergyLearningStrategy.actor_architecture_classEnergyLearningStrategy.actorEnergyLearningStrategy.order_typesEnergyLearningStrategy.action_noiseEnergyLearningStrategy.collect_initial_experience_modeEnergyLearningStrategy.calculate_bids()EnergyLearningStrategy.calculate_reward()EnergyLearningStrategy.get_actions()EnergyLearningStrategy.get_individual_observations()
RenewableEnergyLearningSingleBidStrategyRenewableEnergyLearningSingleBidStrategy.foresightRenewableEnergyLearningSingleBidStrategy.max_bid_priceRenewableEnergyLearningSingleBidStrategy.deviceRenewableEnergyLearningSingleBidStrategy.float_typeRenewableEnergyLearningSingleBidStrategy.learning_modeRenewableEnergyLearningSingleBidStrategy.algorithmRenewableEnergyLearningSingleBidStrategy.actor_architecture_classRenewableEnergyLearningSingleBidStrategy.actorRenewableEnergyLearningSingleBidStrategy.order_typesRenewableEnergyLearningSingleBidStrategy.action_noiseRenewableEnergyLearningSingleBidStrategy.collect_initial_experience_modeRenewableEnergyLearningSingleBidStrategy.calculate_reward()RenewableEnergyLearningSingleBidStrategy.get_individual_observations()
StorageEnergyLearningStrategyStorageEnergyLearningStrategy.foresightStorageEnergyLearningStrategy.max_bid_priceStorageEnergyLearningStrategy.max_demandStorageEnergyLearningStrategy.deviceStorageEnergyLearningStrategy.float_typeStorageEnergyLearningStrategy.learning_modeStorageEnergyLearningStrategy.algorithmStorageEnergyLearningStrategy.actor_architecture_classStorageEnergyLearningStrategy.actorStorageEnergyLearningStrategy.order_typesStorageEnergyLearningStrategy.action_noiseStorageEnergyLearningStrategy.collect_initial_experience_modeStorageEnergyLearningStrategy.calculate_bids()StorageEnergyLearningStrategy.calculate_reward()StorageEnergyLearningStrategy.get_individual_observations()
TorchLearningStrategy
- assume.strategies.naive_strategies module
- assume.strategies.interactive_strategies module
- assume.strategies.portfolio_strategies module
- Module contents
Reinforcement learning algorithms#
- Reinforcement learning algorithms
- Submodules
- assume.reinforcement_learning.buffer module
- assume.reinforcement_learning.learning_role module
LearningLearning.add_actions_to_cache()Learning.add_observation_to_cache()Learning.add_reward_to_cache()Learning.compare_and_save_policies()Learning.create_learning_algorithm()Learning.determine_validation_interval()Learning.get_inter_episodic_data()Learning.get_progress_remaining()Learning.init_logging()Learning.initialize_policy()Learning.load_inter_episodic_data()Learning.on_ready()Learning.register_strategy()Learning.store_to_buffer_and_update()Learning.sync_train_freq_with_simulation_horizon()Learning.turn_off_initial_exploration()Learning.write_rl_grad_params_to_output()Learning.write_rl_params_to_output()
- 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.as_dict()BaseUnit.calculate_bids()BaseUnit.calculate_cashflow()BaseUnit.calculate_cashflow_and_reward()BaseUnit.calculate_generation_cost()BaseUnit.calculate_marginal_cost()BaseUnit.execute_current_dispatch()BaseUnit.get_output_before()BaseUnit.get_starting_costs()BaseUnit.set_dispatch_plan()
ExchangeStrategyLearningConfigLearningConfig.action_noise_scheduleLearningConfig.actor_architectureLearningConfig.algorithmLearningConfig.batch_sizeLearningConfig.continue_learningLearningConfig.deviceLearningConfig.early_stopping_stepsLearningConfig.early_stopping_thresholdLearningConfig.episodes_collecting_initial_experienceLearningConfig.evaluation_modeLearningConfig.exploration_noise_stdLearningConfig.gammaLearningConfig.gradient_stepsLearningConfig.learning_modeLearningConfig.learning_rateLearningConfig.learning_rate_scheduleLearningConfig.max_bid_priceLearningConfig.min_bid_priceLearningConfig.noise_dtLearningConfig.noise_scaleLearningConfig.noise_sigmaLearningConfig.policy_delayLearningConfig.replay_buffer_sizeLearningConfig.target_noise_clipLearningConfig.target_policy_noiseLearningConfig.tauLearningConfig.train_freqLearningConfig.trained_policies_load_pathLearningConfig.trained_policies_save_pathLearningConfig.training_episodesLearningConfig.validation_episodes_interval
LearningStrategyMinMaxChargeStrategyMinMaxStrategySupportsMinMaxSupportsMinMax.calculate_min_max_power()SupportsMinMax.calculate_ramp()SupportsMinMax.efficiencySupportsMinMax.emission_factorSupportsMinMax.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.capacitySupportsMinMaxCharge.efficiency_chargeSupportsMinMaxCharge.efficiency_dischargeSupportsMinMaxCharge.initial_socSupportsMinMaxCharge.max_power_chargeSupportsMinMaxCharge.max_power_dischargeSupportsMinMaxCharge.min_power_chargeSupportsMinMaxCharge.min_power_dischargeSupportsMinMaxCharge.ramp_down_chargeSupportsMinMaxCharge.ramp_down_dischargeSupportsMinMaxCharge.ramp_up_chargeSupportsMinMaxCharge.ramp_up_dischargeSupportsMinMaxCharge.set_dispatch_plan()
- assume.common.exceptions module
- assume.common.mango_serializer module
- assume.common.market_objects module
ClearingMessageDataRequestMessageMarketConfigMarketConfig.additional_fieldsMarketConfig.addrMarketConfig.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
MarketProductMetaDictOnlyHoursOpeningMessageOrderOrderBookMessageProductRegistrationMessageRegistrationReplyMessageonly_co2emissionless()only_renewables()power_plant_not_negative()
- assume.common.outputs module
DatabaseMaintenanceOutputDefWriteOutputWriteOutput.check_columns()WriteOutput.convert_flows()WriteOutput.convert_market_dispatch()WriteOutput.convert_market_orders()WriteOutput.convert_market_results()WriteOutput.convert_rl_grad_params()WriteOutput.convert_rl_params()WriteOutput.convert_unit_dispatch()WriteOutput.convert_units_definition()WriteOutput.delete_db_scenario()WriteOutput.get_sum_reward()WriteOutput.handle_output_message()WriteOutput.on_ready()WriteOutput.on_stop()WriteOutput.setup()WriteOutput.store_dfs()WriteOutput.store_grid()
- assume.common.units_operator module
UnitsOperatorUnitsOperator.available_marketsUnitsOperator.registered_marketsUnitsOperator.last_sent_dispatchUnitsOperator.portfolio_strategiesUnitsOperator.valid_ordersUnitsOperator.unitsUnitsOperator.idUnitsOperator.contextUnitsOperator.add_unit()UnitsOperator.calculate_unit_cashflow_and_reward()UnitsOperator.get_actual_dispatch()UnitsOperator.handle_data_request()UnitsOperator.handle_market_feedback()UnitsOperator.handle_opening()UnitsOperator.handle_registration_feedback()UnitsOperator.on_ready()UnitsOperator.participate()UnitsOperator.register_market()UnitsOperator.set_unit_dispatch()UnitsOperator.setup()UnitsOperator.store_units()UnitsOperator.submit_bids()UnitsOperator.write_actual_dispatch()
- assume.common.utils module
adjust_unit_operator_for_learning()aggregate_step_amount()calculate_content_size()confirm_learning_save_path()convert_tensors()convert_to_rrule_freq()create_incidence_matrix()create_rrule()datetime2timestamp()get_available_products()get_products_index()get_supported_solver()initializer()interactive_input()min_max_scale()normalize_availability()parse_duration()plot_orderbook()rename_study_case()separate_orders()str_to_bool()timestamp2datetime()visualize_orderbook()
- assume.common.grid_utils module
- Module contents