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)
def test_port_creation():
env = Environment()
port = Port(env)
item = SampleItem()
port.put(item)
port.put(item)
items = [item for item in port.items if item.type == "SampleItem"]
assert len(items) == 2
def test_get_item():
env = Environment()
port = Port(env)
item = SampleItem()
port.put(item)
port.put(item)
returned = port.get_item("SampleItem")
assert returned == item
assert len(port.items) == 1
port.put({"type": "Not type Cargo"})
with pytest.raises(ItemNotFound):
_ = port.get_item("WrongItem")
_ = port.get_item("SampleItem")
with pytest.raises(ItemNotFound):
_ = port.get_item("SampleItem")
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)
@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.
"""
try:
cranes = self.config["port"]["num_cranes"]
self.port = Port(self.env)
self.port.crane = simpy.Resource(self.env, cranes)
except KeyError:
self.port = Port(self.env)
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"
rate = self.config["port"].get("monthly_rate", self.defaults[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
def __init__(self, config, **kwargs):
"""Creates an instance of SampleInstallPhase."""
self.config = config
self.env = Environment()
def env():
return Environment("Test Environment", state=test_weather)