def test_interp():
env = Environment(state=weather)
assert "windspeed_20m" not in env.state.dtype.names
constraints = {"waveheight": le(2), "windspeed_20m": le(10)}
valid = env._find_valid_constraints(**constraints)
assert "windspeed_20m" in env.state.dtype.names
assert (env.state["windspeed_10m"] < env.state["windspeed_20m"]).all()
assert (env.state["windspeed_20m"] < env.state["windspeed_100m"]).all()
def initialize_environment(self, weather, **kwargs):
"""
Initializes a `marmot.Environment` at `self.env`.
Parameters
----------
weather : np.ndarray
Weather profile at site.
"""
env_name = kwargs.get("env_name", "Environment")
self.env = Environment(name=env_name, state=weather, **kwargs)
def test_inputs():
env = Environment(state=weather)
assert "waveheight" in env.state.dtype.names
assert "windspeed" not in env.state.dtype.names
assert "windspeed_10m" in env.state.dtype.names
assert "windspeed_100m" in env.state.dtype.names
assert "windspeed_1.2m" in env.state.dtype.names
env2 = Environment(state=weather, ws_alpha=0.12, ws_default_height=20)
assert env2.alpha == 0.12
assert env2.default_height == 20
def test_simple_constraint_application():
env = Environment(state=simple_weather)
constraints = {"windspeed": le(10)}
valid = env._find_valid_constraints(**constraints)
assert valid == constraints
with_height = {"windspeed_100m": le(10)}
valid = env._find_valid_constraints(**with_height)
assert "windspeed" in list(valid.keys())
with_mult_heights = {"windspeed_100m": le(10), "windspeed_10m": le(8)}
with pytest.raises(ValueError):
valid = env._find_valid_constraints(**with_mult_heights)
def initialize_environment(self, weather, **kwargs):
"""
Initializes a `marmot.Environment` at `self.env`.
Parameters
----------
weather : np.ndarray
Weather profile at site.
"""
if isinstance(weather, pd.DataFrame):
weather = weather.to_records()
env_name = kwargs.get("env_name", "Environment")
self.env = Environment(name=env_name, state=weather, **kwargs)
def test_extrap():
env = Environment(state=weather)
assert "windspeed_120m" not in env.state.dtype.names
constraints = {"waveheight": le(2), "windspeed_120m": le(10)}
valid = env._find_valid_constraints(**constraints)
assert "windspeed_120m" in env.state.dtype.names
assert (env.state["windspeed_120m"] > env.state["windspeed_100m"]).all()
env2 = Environment(state=weather, ws_alpha=0.12)
assert "windspeed_120m" not in env2.state.dtype.names
constraints = {"waveheight": le(2), "windspeed_120m": le(10)}
valid = env2._find_valid_constraints(**constraints)
assert (env.state["windspeed_100m"] == env2.state["windspeed_100m"]).all()
assert (env.state["windspeed_120m"] < env2.state["windspeed_120m"]).all()
def test_constraint_application():
env = Environment(state=weather)
constraints = {"waveheight": le(2), "windspeed": le(10)}
valid = env._find_valid_constraints(**constraints)
assert "windspeed_10m" in list(valid.keys())
constraints = {"waveheight": le(2), "windspeed_10m": le(10)}
valid = env._find_valid_constraints(**constraints)
assert "waveheight" in list(valid.keys())
assert "windspeed_10m" in list(valid.keys())
assert "windspeed_20m" not in env.state.dtype.names
constraints = {"waveheight": le(2), "windspeed_20m": le(10)}
valid = env._find_valid_constraints(**constraints)
assert "windspeed_20m" in list(valid.keys())
assert "windspeed_20m" in env.state.dtype.names
assert "windspeed_120m" not in env.state.dtype.names
constraints = {"waveheight": le(2), "windspeed_120m": le(10)}
valid = env._find_valid_constraints(**constraints)
assert "windspeed_120m" in list(valid.keys())
assert "windspeed_120m" in env.state.dtype.names
def test_simple_inputs():
env = Environment(state=simple_weather)
assert "waveheight" in env.state.dtype.names
assert "windspeed" in env.state.dtype.names
class InstallPhase(BasePhase):
"""BasePhase subclass for install modules."""
def __init__(self, weather, **kwargs):
"""
Creates an instance of `InstallPhase`.
Parameters
----------
weather : np.ndarray
Weather profile at site.
"""
self.extract_phase_kwargs(**kwargs)
self.initialize_environment(weather, **kwargs)
def initialize_environment(self, weather, **kwargs):
"""
Initializes a `marmot.Environment` at `self.env`.
Parameters
----------
weather : np.ndarray
Weather profile at site.
"""
env_name = kwargs.get("env_name", "Environment")
self.env = Environment(name=env_name, state=weather, **kwargs)
@abstractmethod
def setup_simulation(self):
"""
Sets up the required simulation infrastructure
Generally, this creates the port, initializes the items to be
installed, and initializes the vessel(s) used for the installation.
"""
pass
def initialize_port(self):
"""
Initializes a Port object with N number of cranes.
"""
self.port = Port(self.env)
try:
cranes = self.config["port"]["num_cranes"]
self.port.crane = simpy.Resource(self.env, cranes)
except KeyError:
self.port.crane = simpy.Resource(self.env, 1)
def run(self, until=None):
"""
Runs the simulation on self.env.
Parameters
----------
until : int, optional
Number of steps to run.
"""
self.env._submit_log({"message": "SIMULATION START"}, "DEBUG")
self.env.run(until=until)
self.append_phase_info()
self.env._submit_log({"message": "SIMULATION END"}, "DEBUG")
def append_phase_info(self):
"""Appends phase information to all logs in `self.env.logs`."""
for l in self.env.logs:
l["phase"] = self.phase
@property
def port_costs(self):
"""Cost of port rental."""
port = getattr(self, "port", None)
if port is None:
return 0
else:
key = "port_cost_per_month"
port_config = self.config.get("port", {})
rate = port_config.get("monthly_rate", common_costs[key])
months = self.total_phase_time / (8760 / 12)
return months * rate
@property
def total_phase_cost(self):
"""Returns total phase cost in $USD."""
return self.action_costs + self.port_costs
@property
def action_costs(self):
"""Returns sum cost of all actions."""
return np.nansum([a["cost"] for a in self.env.actions])
@property
def total_phase_time(self):
"""Returns total phase time in hours."""
return max([a["time"] for a in self.env.actions])
@property
@abstractmethod
def detailed_output(self):
"""Returns detailed phase information."""
pass
@property
def agent_efficiencies(self):
"""
Returns a summary of agent operational efficiencies.
"""
efficiencies = {}
s = sorted(self.env.actions, key=lambda x: (x["agent"], x["action"]))
grouped = {
k: sum([i["duration"] for i in list(v)])
for k, v in groupby(s, key=lambda x: (x["agent"], x["action"]))
}
agents = list(set([k[0] for k in grouped.keys()]))
for agent in agents:
total = sum([v for k, v in grouped.items() if k[0] == agent])
try:
delay = grouped[(agent, "Delay")]
e = (total - delay) / total
except KeyError:
delay = 0.0
e = 1.0
except ZeroDivisionError:
e = 1.0
if not 0.0 <= e <= 1.0:
raise ValueError(f"Invalid efficiency for agent '{agent}'")
name = str(agent).replace(" ", "_")
efficiencies[f"{name}_operational_efficiency"] = e
return efficiencies
@staticmethod
def get_max_cargo_mass_utilzations(vessels):
"""
Returns a summary of cargo mass efficiencies for list of input `vessels`.
Parameters
----------
vessels : list
List of vessels to calculate efficiencies for.
"""
outputs = {}
for vessel in vessels:
name = vessel.name.replace(" ", "_")
storage = getattr(vessel, "storage", None)
if storage is None:
print("Vessel does not have storage capacity.")
continue
outputs[
f"{name}_cargo_mass_utilization"] = vessel.max_cargo_mass_utilization
return outputs
@staticmethod
def get_max_deck_space_utilzations(vessels):
"""
Returns a summary of deck space efficiencies for list of input `vessels`.
Parameters
----------
vessels : list
List of vessels to calculate efficiencies for.
"""
outputs = {}
for vessel in vessels:
name = vessel.name.replace(" ", "_")
storage = getattr(vessel, "storage", None)
if storage is None:
print("Vessel does not have storage capacity.")
continue
outputs[
f"{name}_deck_space_utilization"] = vessel.max_deck_space_utilization
return outputs