add amiris scenario loader (#224)

This allows loading scenarios which were originally written for AMIRIS
by DLR

assume/common/scenario_loader_amiris.py

@@ -0,0 +1,287 @@
+import logging
+from datetime import datetime, timedelta
+
+import dateutil.rrule as rr
+import numpy as np
+import pandas as pd
+import yaml
+from tqdm import tqdm
+
+from assume.common.base import LearningConfig
+from assume.common.forecasts import CsvForecaster, Forecaster, NaiveForecast
+from assume.common.market_objects import MarketConfig, MarketProduct
+from assume.world import World
+
+logger = logging.getLogger(__name__)
+import yaml
+from yamlinclude import YamlIncludeConstructor
+
+translate_clearing = {
+    "SAME_SHARES": "pay_as_clear",
+    "FIRST_COME_FIRST_SERVE": "pay_as_bid",
+    "RANDOMIZE": "not_implemented_yet",
+}
+translate_fuel_type = {
+    "NUCLEAR": "nuclear",
+    "LIGNITE": "lignite",
+    "HARD_COAL": "hard coal",
+    "NATURAL_GAS": "natural gas",
+    "OIL": "oil",
+    "HYDROGEN": "hydrogen",
+    "Biogas": "biomass",
+    "PV": "solar",
+    "WindOn": "wind_onshore",
+    "WindOff": "wind_offshore",
+    "RunOfRiver": "hydro",
+    "Other": "hydro,",
+}
+
+
+def read_csv(base_path, filename):
+    return pd.read_csv(
+        base_path + "/" + filename,
+        date_format="%Y-%m-%d_%H:%M:%S",
+        sep=";",
+        header=None,
+        names=["time", "load"],
+        index_col="time",
+    )["load"]
+
+
+def get_send_receive_msgs_per_id(agent_id, contracts_config: list):
+    sends = []
+    receives = []
+    for contracts in contracts_config:
+        for contract in contracts["Contracts"]:
+            # sends
+            if isinstance(contract["SenderId"], list):
+                if agent_id in contract["SenderId"]:
+                    sends.append(contract)
+            elif agent_id == contract["SenderId"]:
+                sends.append(contract)
+            # receives
+            if isinstance(contract["ReceiverId"], list):
+                if agent_id in contract["ReceiverId"]:
+                    receives.append(contract)
+            elif agent_id == contract["ReceiverId"]:
+                receives.append(contract)
+    return sends, receives
+
+
+def get_matching_send_one_or_multi(agent_id: int, contract: dict):
+    assert isinstance(contract["SenderId"], list)
+    # if the receiver is only one - use it
+    if not isinstance(contract["ReceiverId"], list):
+        return contract["ReceiverId"]
+
+    # else we need to find the matching index
+    idx = contract["SenderId"].index(agent_id)
+    return contract["ReceiverId"][idx]
+
+
+def add_agent_to_world(
+    agent: dict, world: World, prices: dict, contracts: list, base_path: str
+):
+    match agent["Type"]:
+        case "EnergyExchange":
+            market_config = MarketConfig(
+                f"Market_{agent['Id']}",
+                rr.rrule(rr.HOURLY, interval=1, dtstart=world.start, until=world.end),
+                timedelta(hours=1),
+                translate_clearing[agent["Attributes"]["DistributionMethod"]],
+                [MarketProduct(timedelta(hours=1), 1, timedelta(hours=1))],
+                maximum_bid_volume=99999,
+            )
+            world.add_market_operator(f"Market_{agent['Id']}")
+            world.add_market(f"Market_{agent['Id']}", market_config)
+        case "CarbonMarket":
+            co2_price = agent["Attributes"]["Co2Prices"]
+            if isinstance(co2_price, str):
+                price_series = read_csv(base_path, co2_price)
+                co2_price = price_series.reindex(world.index).ffill().fillna(0)
+            prices["co2"] = co2_price
+        case "FuelsMarket":
+            # fill prices for forecaster
+            for fuel in agent["Attributes"]["FuelPrices"]:
+                fuel_type = translate_fuel_type[fuel["FuelType"]]
+                price = fuel["Price"]
+                if isinstance(fuel["Price"], str):
+                    price_series = read_csv(base_path, fuel["Price"])
+                    price_series.index = price_series.index.round("h")
+                    if not price_series.index.is_unique:
+                        price_series = price_series.groupby(level=0).last()
+                    price = price_series.reindex(world.index).ffill()
+                prices[fuel_type] = price * fuel["ConversionFactor"]
+        case "DemandTrader":
+            world.add_unit_operator(agent["Id"])
+
+            for i, load in enumerate(agent["Attributes"]["Loads"]):
+                demand_series = -read_csv(base_path, load["DemandSeries"])
+                world.add_unit(
+                    f"demand_{agent['Id']}_{i}",
+                    "demand",
+                    agent["Id"],
+                    {
+                        "min_power": 0,
+                        "max_power": 100000,
+                        "bidding_strategies": {"energy": "naive"},
+                        "technology": "demand",
+                        "price": load["ValueOfLostLoad"],
+                    },
+                    NaiveForecast(world.index, demand=demand_series),
+                )
+
+        case "StorageTrader":
+            world.add_unit_operator(f"Operator_{agent['Id']}")
+        case "RenewableTrader":
+            world.add_unit_operator(f"Operator_{agent['Id']}")
+            # send, receive = get_send_receive_msgs_per_id(agent["Id"], contracts)
+        case "NoSupportTrader":
+            # does not get support - just trades renewables
+            # has a ShareOfRevenues (how much of the profit he keeps)
+            world.add_unit_operator(f"Operator_{agent['Id']}")
+        case "SystemOperatorTrader":
+            world.add_unit_operator(f"Operator_{agent['Id']}")
+
+        case "ConventionalPlantOperator" | "ConventionalTrader":
+            # this can be left out for now - we only use the actual plant
+            # TODO the conventional Trader sets markup for the according plantbuilder - we should respect that too
+            world.add_unit_operator(f"Operator_{agent['Id']}")
+            pass
+        case "PredefinedPlantBuilder":
+            # this is the actual powerplant
+            prototype = agent["Attributes"]["Prototype"]
+            attr = agent["Attributes"]
+            send, receive = get_send_receive_msgs_per_id(agent["Id"], contracts)
+            operator_id = get_matching_send_one_or_multi(agent["Id"], send[0])
+            operator_id = f"Operator_{operator_id}"
+            fuel_price = prices.get(translate_fuel_type[prototype["FuelType"]], 0)
+            fuel_price += prototype.get("OpexVarInEURperMWH", 0)
+            # TODO CyclingCostInEURperMW
+            forecast = NaiveForecast(
+                world.index,
+                availability=prototype["PlannedAvailability"],
+                fuel_price=fuel_price,
+                co2_price=prices.get("co2", 2),
+            )
+            # TODO UnplannedAvailabilityFactor is not respected
+            world.add_unit(
+                f"PredefinedPlantBuilder_{agent['Id']}",
+                "power_plant",
+                operator_id,
+                {
+                    # I think AMIRIS plans per block - so minimum is 1 block
+                    "min_power": attr["BlockSizeInMW"],
+                    "max_power": attr["InstalledPowerInMW"],
+                    "bidding_strategies": {"energy": "naive"},
+                    "technology": translate_fuel_type[prototype["FuelType"]],
+                    "fuel_type": translate_fuel_type[prototype["FuelType"]],
+                    "emission_factor": prototype["SpecificCo2EmissionsInTperMWH"],
+                    "efficiency": sum(attr["Efficiency"].values()) / 2,
+                },
+                forecast,
+            )
+        case "VariableRenewableOperator" | "Biogas":
+            send, receive = get_send_receive_msgs_per_id(agent["Id"], contracts)
+            operator_id = get_matching_send_one_or_multi(agent["Id"], send[0])
+            operator_id = f"Operator_{operator_id}"
+            attr = agent["Attributes"]
+            availability = attr.get("YieldProfile", attr.get("DispatchTimeSeries"))
+            if isinstance(availability, str):
+                dispatch_profile = read_csv(base_path, availability)
+                availability = dispatch_profile.reindex(world.index).ffill().fillna(0)
+            fuel_price = prices.get(translate_fuel_type[attr["EnergyCarrier"]], 0)
+            fuel_price += attr.get("OpexVarInEURperMWH", 0)
+            forecast = NaiveForecast(
+                world.index,
+                availability=availability,
+                fuel_price=fuel_price,
+                co2_price=prices.get("co2", 0),
+            )
+            # TODO attr["SupportInstrument"] and
+            world.add_unit(
+                f"VariableRenewableOperator_{agent['Id']}",
+                "power_plant",
+                operator_id,
+                {
+                    "min_power": 0,
+                    "max_power": attr["InstalledPowerInMW"],
+                    "bidding_strategies": {"energy": "naive"},
+                    "technology": translate_fuel_type[attr["EnergyCarrier"]],
+                    "fuel_type": translate_fuel_type[attr["EnergyCarrier"]],
+                    "emission_factor": 0,
+                    "efficiency": 1,
+                },
+                forecast,
+            )
+
+
+def read_amiris_yaml(base_path):
+    YamlIncludeConstructor.add_to_loader_class(
+        loader_class=yaml.FullLoader, base_dir=base_path
+    )
+
+    with open(base_path + "/scenario.yaml", "rb") as f:
+        amiris_scenario = yaml.load(f, Loader=yaml.FullLoader)
+    return amiris_scenario
+
+
+async def load_amiris_async(
+    world: World,
+    scenario: str,
+    study_case: str,
+    base_path: str,
+):
+    # In practice - this seems fixed in AMIRIS
+    DeliveryIntervalInSteps = 3600
+
+    amiris_scenario = read_amiris_yaml(base_path)
+
+    start = amiris_scenario["GeneralProperties"]["Simulation"]["StartTime"]
+    start = pd.to_datetime(start, format="%Y-%m-%d_%H:%M:%S")
+    end = amiris_scenario["GeneralProperties"]["Simulation"]["StopTime"]
+    end = pd.to_datetime(end, format="%Y-%m-%d_%H:%M:%S")
+    # AMIRIS caveat: start and end is always two minutes before actual start
+    start += timedelta(minutes=2)
+    sim_id = f"{scenario}_{study_case}"
+    save_interval = amiris_scenario["GeneralProperties"]["Output"]["Interval"]
+    prices = {}
+    index = pd.date_range(start=start, end=end, freq="1h", inclusive="left")
+    await world.setup(
+        start=start,
+        end=end,
+        save_frequency_hours=save_interval,
+        simulation_id=sim_id,
+        index=index,
+    )
+    for agent in amiris_scenario["Agents"]:
+        add_agent_to_world(
+            agent, world, prices, amiris_scenario["Contracts"], base_path
+        )
+
+
+if __name__ == "__main__":
+    # To use this with amiris run:
+    # git clone https://gitlab.com/dlr-ve/esy/amiris/examples.git amiris-examples
+    # next to the assume folder
+    scenario = "Germany2019"  # Germany2019 or Austria2019 or Simple
+    base_path = f"../amiris-examples/{scenario}/"
+    amiris_scenario = read_amiris_yaml(base_path)
+    sends, receives = get_send_receive_msgs_per_id(1000, amiris_scenario["Contracts"])
+
+    demand_agent = amiris_scenario["Agents"][3]
+    demand_series = read_csv(
+        base_path, demand_agent["Attributes"]["Loads"][0]["DemandSeries"]
+    )
+
+    db_uri = "postgresql://assume:assume@localhost:5432/assume"
+    world = World(database_uri=db_uri)
+    world.loop.run_until_complete(
+        load_amiris_async(
+            world,
+            "amiris",
+            scenario,
+            base_path,
+        )
+    )
+    world.run()