def create_value_federate(deltat=1.0, fedinitstring="--federates=1"):
logger.debug("Creating federateinfo")
fedinfo = h.helicsFederateInfoCreate()
logger.debug("Setting name")
status = h.helicsFederateInfoSetFederateName(fedinfo, "MarketSim")
assert status == 0
logger.debug("Setting core type")
status = h.helicsFederateInfoSetCoreTypeFromString(fedinfo, "zmq")
assert status == 0
logger.debug("Setting init string")
status = h.helicsFederateInfoSetCoreInitString(fedinfo, fedinitstring)
assert status == 0
logger.debug("Setting time delta")
status = h.helicsFederateInfoSetTimeDelta(fedinfo, deltat)
assert status == 0
logger.debug("Setting logging level")
status = h.helicsFederateInfoSetLoggingLevel(fedinfo, 1)
assert status == 0
logger.debug("Creating CombinationFederate")
fed = h.helicsCreateCombinationFederate(fedinfo)
return fed
def create_federate(deltat=1.0, fedinitstring="--federates=1"):
fedinfo = h.helicsCreateFederateInfo()
h.helicsFederateInfoSetCoreName(fedinfo, "PythonLoadshedFederate")
h.helicsFederateInfoSetCoreTypeFromString(fedinfo, "zmq")
h.helicsFederateInfoSetCoreInitString(fedinfo, fedinitstring)
h.helicsFederateInfoSetTimeProperty(fedinfo, h.helics_property_time_delta,
deltat)
fed = h.helicsCreateCombinationFederate("PythonLoadshedFederate", fedinfo)
return fed
def test_python_api0():
broker = h.helicsCreateBroker("zmq", "", "-f 1 --name=mainbroker")
fedinfo = h.helicsCreateFederateInfo()
assert "HelicsFederateInfo()" in repr(fedinfo)
fedinfo.core_name = "TestFederate"
fedinfo.core_type = "zmq"
fedinfo.core_init = "-f 1 --broker=mainbroker"
mFed = h.helicsCreateCombinationFederate("TestFederate", fedinfo)
assert (
"""HelicsCombinationFederate(name = "TestFederate", state = HelicsFederateState.STARTUP, current_time = -9223372036.854776, n_publications = 0, n_subscriptions = 0, n_endpoints = 0, n_filters = 0, n_pending_messages = 0)"""
in repr(mFed))
_ = mFed.register_endpoint("ep1")
_ = mFed.register_global_endpoint("ep2")
pub = mFed.register_publication("publication", h.HELICS_DATA_TYPE_STRING,
"custom-units")
assert """HelicsPublication(name = "TestFederate/publication", type = "string", units = "custom-units", info = "")""" in repr(
pub)
sub = mFed.register_subscription("subscription", "custom-units")
assert (
"""HelicsInput(name = "_input_3", units = "custom-units", injection_units = "", publication_type = "", type = "", target = "subscription", info = "")"""
in repr(sub))
assert (
"""{ 'CONNECTION_REQUIRED' = 0, 'CONNECTION_OPTIONAL' = 0, 'SINGLE_CONNECTION_ONLY' = 0, 'MULTIPLE_CONNECTIONS_ALLOWED' = 1, 'BUFFER_DATA' = 0, 'STRICT_TYPE_CHECKING' = 0, 'IGNORE_UNIT_MISMATCH' = 0, 'ONLY_TRANSMIT_ON_CHANGE' = 0, 'ONLY_UPDATE_ON_CHANGE' = 0, 'IGNORE_INTERRUPTS' = 0, 'MULTI_INPUT_HANDLING_METHOD' = 0, 'INPUT_PRIORITY_LOCATION' = -1, 'CLEAR_PRIORITY_LIST' = 1, 'CONNECTIONS' = 0 }"""
in repr(sub.option))
sub.option["CONNECTION_REQUIRED"] = 1
sub.option[h.HELICS_HANDLE_OPTION_CONNECTION_REQUIRED] = 1
assert sub.option["CONNECTION_REQUIRED"] == 1
sub.add_target("")
mFed.property[h.HELICS_PROPERTY_TIME_DELTA] = 1.0
assert mFed.property[h.HELICS_PROPERTY_TIME_DELTA] == 1.0
mFed.property["TIME_DELTA"] = 1.0
assert mFed.property["TIME_DELTA"] == 1.0
with pt.raises(h.HelicsException):
mFed.enter_executing_mode()
h.helicsCloseLibrary()
del mFed
del broker
def create_value_federate(deltat=1.0, fedinitstring="--federates=1 --tick=0"):
fedinfo = h.helicsCreateFederateInfo()
h.helicsFederateInfoSetCoreName(fedinfo, "TestB Federate")
h.helicsFederateInfoSetCoreTypeFromString(fedinfo, "zmq")
h.helicsFederateInfoSetCoreInitString(fedinfo, fedinitstring)
h.helicsFederateInfoSetTimeProperty(fedinfo, h.helics_property_time_delta,
deltat)
h.helicsFederateInfoSetIntegerProperty(fedinfo,
h.helics_property_int_log_level, 1)
fed = h.helicsCreateCombinationFederate("TestB Federate", fedinfo)
return fed
def test_python_api6():
broker = h.helicsCreateBroker("zmq", "broker", "--federates 1")
fi = h.helicsCreateFederateInfo()
fed = h.helicsCreateCombinationFederate("test1", fi)
fed.enter_initializing_mode()
fed.enter_executing_mode()
fed.core.disconnect()
assert fed.core.wait_for_disconnect()
del fed
broker.disconnect()
assert broker.wait_for_disconnect()
del broker
h.helicsCleanupLibrary()
h.helicsCloseLibrary()
def create_combo_federate(fedinitstring, name, period):
fedinfo = h.helicsCreateFederateInfo()
# "coreType": "zmq",
h.helicsFederateInfoSetCoreTypeFromString(fedinfo, "zmq")
h.helicsFederateInfoSetCoreInitString(fedinfo, fedinitstring)
# "loglevel": 1,
h.helicsFederateInfoSetIntegerProperty(fedinfo,
h.helics_property_int_log_level, 11)
# "period": 60,
h.helicsFederateInfoSetTimeProperty(fedinfo, h.helics_property_time_period,
period)
# "uninterruptible": false,
h.helicsFederateInfoSetFlagOption(fedinfo, h.helics_flag_uninterruptible,
False)
# "terminate_on_error": true,
h.helicsFederateInfoSetFlagOption(fedinfo,
h.HELICS_FLAG_TERMINATE_ON_ERROR, True)
#h.helicsFederateInfoSetFlagOption(fedinfo, 72, True)
# "name": "Charger",
fed = h.helicsCreateCombinationFederate(name, fedinfo)
return fed
def test_python_api5():
broker = h.helicsCreateBroker("zmq", "broker", "--federates 1")
fi = h.helicsCreateFederateInfo()
fed = h.helicsCreateCombinationFederate("test1", fi)
with pt.raises(h.HelicsException):
fed.register_interfaces("unknownfile.json")
fed.core.disconnect()
assert fed.core.wait_for_disconnect()
del fed
broker.disconnect()
assert broker.wait_for_disconnect()
del broker
h.helicsCleanupLibrary()
h.helicsCloseLibrary()
def create_value_federate(deltat=1.0, fedinitstring="--federates=1"):
fedinfo = h.helicsFederateInfoCreate()
status = h.helicsFederateInfoSetFederateName(fedinfo, "TestB Federate")
assert status == 0
status = h.helicsFederateInfoSetCoreTypeFromString(fedinfo, "zmq")
assert status == 0
status = h.helicsFederateInfoSetCoreInitString(fedinfo, fedinitstring)
assert status == 0
status = h.helicsFederateInfoSetTimeDelta(fedinfo, deltat)
assert status == 0
status = h.helicsFederateInfoSetLoggingLevel(fedinfo, 1)
assert status == 0
fed = h.helicsCreateCombinationFederate(fedinfo)
return fed
def create_federate(deltat=1.0, fedinitstring="--federates=1"):
fedinfo = h.helicsCreateFederateInfo()
h.helicsFederateInfoSetCoreName(fedinfo, "Combination Federate A")
# assert status == 0
h.helicsFederateInfoSetCoreTypeFromString(fedinfo, "zmq")
# assert status == 0
h.helicsFederateInfoSetCoreInitString(fedinfo, fedinitstring)
# assert status == 0
h.helicsFederateInfoSetTimeProperty(fedinfo, h.helics_property_time_delta,
deltat)
# assert status == 0
# h.helicsFederateInfoSetLoggingLevel(fedinfo, 1)
# assert status == 0
fed = h.helicsCreateCombinationFederate("Combination Federate A", fedinfo)
return fed
# -*- coding: utf-8 -*-
import os
import helics as h
from math import pi
import time
initstring = "-f 2 --loglevel=7"
broker = h.helicsCreateBroker("zmq", "", initstring)
assert h.helicsBrokerIsConnected(broker) is True
fedinfo = h.helicsCreateFederateInfo()
h.helicsFederateInfoSetCoreType(fedinfo, h.helics_core_type_zmq)
h.helicsFederateInfoSetCoreInitString(fedinfo, "--loglevel=7")
h.helicsFederateInfoSetTimeProperty(fedinfo, h.helics_property_time_delta, 1.0)
fed = h.helicsCreateCombinationFederate("sender", fedinfo,)
topicA = h.helicsFederateRegisterGlobalPublication(
fed, "topicA", h.helics_data_type_double, ""
)
h.helicsFederateEnterExecutingMode(fed)
currenttime = 0
for t in range(5, 10 + 1):
while currenttime < t:
currenttime = h.helicsFederateRequestTime(fed, t)
print(f"Sending value = {pi} at time = {currenttime}")
h.helicsPublicationPublishDouble(topicA, pi)
h.helicsFederateFinalize(fed)
h.helicsFederateFree(fed)
h.helicsFederateInfoSetCoreTypeFromString(fedinfo, "zmq")
# Federate init string #
h.helicsFederateInfoSetCoreInitString(fedinfo, fedinitstring)
# Set the message interval (timedelta) for federate. Note th#
# HELICS minimum message time interval is 1 ns and by default
# it uses a time delta of 1 second. What is provided to the
# setTimedelta routine is a multiplier for the default timedelta.
# Set one second message interval #
h.helicsFederateInfoSetTimeProperty(fedinfo, h.helics_property_time_delta,
deltat)
# Create value federate #
vfed = h.helicsCreateCombinationFederate("TestA Federate", fedinfo)
print("PI SENDER: Value federate created")
# Register the publication #
pub = h.helicsFederateRegisterGlobalTypePublication(vfed, "testA", "double",
"")
print("PI SENDER: Publication registered")
epid = h.helicsFederateRegisterGlobalEndpoint(vfed, "endpoint1", "")
fid = h.helicsFederateRegisterFilter(vfed, h.helics_filter_type_delay,
"filter1")
h.helicsFilterAddSourceTarget(fid, "endpoint1")
h.helicsFilterSet(fid, "delay", 2.0)
# Set the message interval (timedelta) for federate. Note that
# HELICS minimum message time interval is 1 ns and by default
# it uses a time delta of 1 second. What is provided to the
# setTimedelta routine is a multiplier for the default timedelta.
# Set one second message interval
print("PI RECEIVER: Setting Federate Info Time Delta")
status = h.helicsFederateInfoSetPeriod(fedinfo, timePeriod)
print("PI RECEIVER: Setting Federate Info Logging")
status = h.helicsFederateInfoSetLoggingLevel(fedinfo, 1)
# Create value federate
print("PI RECEIVER: Creating Value Federate")
fed = h.helicsCreateCombinationFederate(fedinfo)
print("PI RECEIVER: Value federate created")
# Subscribe to PI SENDER's publication
sub = h.helicsFederateRegisterSubscription(fed, "testA", "double", "")
print("PI RECEIVER: Subscription registered")
epid = h.helicsFederateRegisterGlobalEndpoint(fed, "endpoint2", "")
status = h.helicsFederateEnterExecutionMode(fed)
print("PI RECEIVER: Entering execution mode")
value = 0.0
prevtime = 0
currenttime = h.helicsFederateRequestTime(fed, 100)[-1]
def test_misc_api():
fedInfo1 = h.helicsCreateFederateInfo()
h.helicsFederateInfoSetCoreInitString(fedInfo1, "-f 1")
h.helicsFederateInfoSetCoreName(fedInfo1, "core3")
h.helicsFederateInfoSetCoreType(fedInfo1, 3)
h.helicsFederateInfoSetCoreTypeFromString(fedInfo1, "zmq")
h.helicsFederateInfoSetFlagOption(fedInfo1, 1, True)
h.helicsFederateInfoSetTimeProperty(fedInfo1,
h.HELICS_PROPERTY_TIME_INPUT_DELAY,
1.0)
h.helicsFederateInfoSetIntegerProperty(fedInfo1,
h.HELICS_PROPERTY_INT_LOG_LEVEL, 1)
h.helicsFederateInfoSetIntegerProperty(
fedInfo1, h.HELICS_PROPERTY_INT_MAX_ITERATIONS, 100)
h.helicsFederateInfoSetTimeProperty(fedInfo1,
h.HELICS_PROPERTY_TIME_OUTPUT_DELAY,
1.0)
h.helicsFederateInfoSetTimeProperty(fedInfo1,
h.HELICS_PROPERTY_TIME_PERIOD, 1.0)
h.helicsFederateInfoSetTimeProperty(fedInfo1, h.HELICS_PROPERTY_TIME_DELTA,
1.0)
h.helicsFederateInfoSetTimeProperty(fedInfo1,
h.HELICS_PROPERTY_TIME_OFFSET, 0.1)
h.helicsFederateInfoFree(fedInfo1)
broker3 = h.helicsCreateBroker("zmq", "broker3",
"--federates 1 --loglevel 1")
fedInfo2 = h.helicsCreateFederateInfo()
coreInitString = "--federates 1"
h.helicsFederateInfoSetCoreInitString(fedInfo2, coreInitString)
h.helicsFederateInfoSetCoreTypeFromString(fedInfo2, "zmq")
h.helicsFederateInfoSetIntegerProperty(fedInfo2,
h.HELICS_PROPERTY_INT_LOG_LEVEL, 1)
h.helicsFederateInfoSetTimeProperty(fedInfo2, h.HELICS_PROPERTY_TIME_DELTA,
1.0)
fed1 = h.helicsCreateCombinationFederate("fed1", fedInfo2)
fed2 = h.helicsFederateClone(fed1)
_ = h.helicsGetFederateByName("fed1")
h.helicsFederateSetFlagOption(fed2, 1, False)
h.helicsFederateSetTimeProperty(fed2, h.HELICS_PROPERTY_TIME_INPUT_DELAY,
1.0)
h.helicsFederateSetIntegerProperty(fed1, h.HELICS_PROPERTY_INT_LOG_LEVEL,
1)
h.helicsFederateSetIntegerProperty(fed2,
h.HELICS_PROPERTY_INT_MAX_ITERATIONS,
100)
h.helicsFederateSetTimeProperty(fed2, h.HELICS_PROPERTY_TIME_OUTPUT_DELAY,
1.0)
h.helicsFederateSetTimeProperty(fed2, h.HELICS_PROPERTY_TIME_PERIOD, 0.0)
h.helicsFederateSetTimeProperty(fed2, h.HELICS_PROPERTY_TIME_DELTA, 1.0)
_ = h.helicsFederateRegisterCloningFilter(fed1, "fed1/Ep1")
fed1DestinationFilter = h.helicsFederateRegisterFilter(
fed1, h.HELICS_FILTER_TYPE_DELAY, "fed1DestinationFilter")
h.helicsFilterAddDestinationTarget(fed1DestinationFilter, "Ep2")
ep1 = h.helicsFederateRegisterEndpoint(fed1, "Ep1", "string")
ep2 = h.helicsFederateRegisterGlobalEndpoint(fed1, "Ep2", "string")
pub1 = h.helicsFederateRegisterGlobalPublication(fed1, "pub1",
h.HELICS_DATA_TYPE_DOUBLE,
"")
pub2 = h.helicsFederateRegisterGlobalTypePublication(
fed1, "pub2", "complex", "")
sub1 = h.helicsFederateRegisterSubscription(fed1, "pub1")
sub2 = h.helicsFederateRegisterSubscription(fed1, "pub2")
h.helicsInputAddTarget(sub2, "Ep2")
pub3 = h.helicsFederateRegisterPublication(fed1, "pub3",
h.HELICS_DATA_TYPE_STRING, "")
pub1KeyString = h.helicsPublicationGetKey(pub1)
pub1TypeString = h.helicsPublicationGetType(pub1)
pub1UnitsString = h.helicsPublicationGetUnits(pub1)
sub1KeyString = h.helicsSubscriptionGetKey(sub1)
sub1UnitsString = h.helicsInputGetUnits(sub1)
assert "pub1" == pub1KeyString
assert "double" == pub1TypeString
assert "" == pub1UnitsString
assert "pub1" == sub1KeyString
assert "" == sub1UnitsString
fed1SourceFilter = h.helicsFederateRegisterFilter(
fed1, h.HELICS_FILTER_TYPE_DELAY, "fed1SourceFilter")
h.helicsFilterAddSourceTarget(fed1SourceFilter, "Ep2")
h.helicsFilterAddDestinationTarget(fed1SourceFilter, "fed1/Ep1")
h.helicsFilterRemoveTarget(fed1SourceFilter, "fed1/Ep1")
h.helicsFilterAddSourceTarget(fed1SourceFilter, "Ep2")
h.helicsFilterRemoveTarget(fed1SourceFilter, "Ep2")
fed1SourceFilterNameString = h.helicsFilterGetName(fed1SourceFilter)
assert fed1SourceFilterNameString == "fed1/fed1SourceFilter"
sub3 = h.helicsFederateRegisterSubscription(fed1, "fed1/pub3", "")
pub4 = h.helicsFederateRegisterTypePublication(fed1, "pub4", "int", "")
sub4 = h.helicsFederateRegisterSubscription(fed1, "fed1/pub4", "")
pub5 = h.helicsFederateRegisterGlobalTypePublication(
fed1, "pub5", "boolean", "")
sub5 = h.helicsFederateRegisterSubscription(fed1, "pub5", "")
pub6 = h.helicsFederateRegisterGlobalPublication(fed1, "pub6",
h.HELICS_DATA_TYPE_VECTOR,
"")
sub6 = h.helicsFederateRegisterSubscription(fed1, "pub6", "")
pub7 = h.helicsFederateRegisterGlobalPublication(
fed1, "pub7", h.HELICS_DATA_TYPE_NAMED_POINT, "")
sub7 = h.helicsFederateRegisterSubscription(fed1, "pub7", "")
assert """helics.HelicsPublication(name = "pub1", type = "double", units = "", info = "")""" in repr(
pub1)
assert """helics.HelicsPublication(name = "pub2", type = "complex", units = "", info = "")""" in repr(
pub2)
assert """helics.HelicsPublication(name = "fed1/pub3", type = "string", units = "", info = "")""" in repr(
pub3)
assert """helics.HelicsPublication(name = "fed1/pub4", type = "int", units = "", info = "")""" in repr(
pub4)
assert """helics.HelicsPublication(name = "pub5", type = "boolean", units = "", info = "")""" in repr(
pub5)
assert """helics.HelicsPublication(name = "pub6", type = "double_vector", units = "", info = "")""" in repr(
pub6)
assert """helics.HelicsPublication(name = "pub7", type = "named_point", units = "", info = "")""" in repr(
pub7)
assert (
"""helics.HelicsInput(name = "_input_18", units = "", injection_units = "", publication_type = "", type = "", target = "pub7", info = "")"""
in repr(sub7))
h.helicsInputSetDefaultBoolean(sub5, False)
h.helicsInputSetDefaultComplex(sub2, -9.9 + 2.5j)
h.helicsInputSetDefaultDouble(sub1, 3.4)
h.helicsInputSetDefaultInteger(sub4, 6)
h.helicsInputSetDefaultNamedPoint(sub7, "hollow", 20.0)
h.helicsInputSetDefaultString(sub3, "default")
sub6Default = [3.4, 90.9, 4.5]
h.helicsInputSetDefaultVector(sub6, sub6Default)
h.helicsEndpointSubscribe(ep2, "fed1/pub3")
h.helicsFederateEnterInitializingModeAsync(fed1)
rs = h.helicsFederateIsAsyncOperationCompleted(fed1)
if rs == 0:
time.sleep(0.500)
rs = h.helicsFederateIsAsyncOperationCompleted(fed1)
if rs == 0:
time.sleep(0.500)
rs = h.helicsFederateIsAsyncOperationCompleted(fed1)
if rs == 0:
assert True is False
h.helicsFederateEnterInitializingModeComplete(fed1)
h.helicsFederateEnterExecutingModeAsync(fed1)
h.helicsFederateEnterExecutingModeComplete(fed1)
assert (
"""helics.HelicsInput(name = "_input_18", units = "", injection_units = "", publication_type = "named_point", type = "", target = "pub7", info = "")"""
in repr(sub7))
mesg1 = h.helicsFederateCreateMessage(fed1)
h.helicsMessageSetString(mesg1, "Hello")
h.helicsMessageSetSource(mesg1, "fed1/Ep1")
h.helicsMessageSetOriginalSource(mesg1, "fed1/Ep1")
h.helicsMessageSetDestination(mesg1, "Ep2")
h.helicsMessageSetOriginalDestination(mesg1, "Ep2")
h.helicsEndpointSendMessage(ep1, mesg1)
mesg1 = h.helicsFederateCreateMessage(fed1)
h.helicsMessageSetString(mesg1, "There")
h.helicsMessageSetSource(mesg1, "fed1/Ep1")
h.helicsMessageSetOriginalSource(mesg1, "fed1/Ep1")
h.helicsMessageSetDestination(mesg1, "Ep2")
h.helicsMessageSetOriginalDestination(mesg1, "Ep2")
h.helicsEndpointSendMessage(ep1, mesg1)
h.helicsEndpointSetDefaultDestination(ep2, "fed1/Ep1")
ep1NameString = h.helicsEndpointGetName(ep1)
ep1TypeString = h.helicsEndpointGetType(ep1)
assert ep1NameString == "fed1/Ep1"
assert ep1TypeString == "string"
_ = h.helicsFederateGetCoreObject(fed1)
fed1Time = h.helicsFederateGetCurrentTime(fed1)
assert fed1Time == 0.0
fed1EndpointCount = h.helicsFederateGetEndpointCount(fed1)
assert fed1EndpointCount == 2
fed1NameString = h.helicsFederateGetName(fed1)
assert fed1NameString == "fed1"
fed1State = h.helicsFederateGetState(fed1)
assert fed1State == 2
fed1PubCount = h.helicsFederateGetPublicationCount(fed1)
assert fed1PubCount == 7
fed1SubCount = h.helicsFederateGetInputCount(fed1)
assert fed1SubCount == 7
h.helicsPublicationPublishBoolean(pub5, True)
h.helicsPublicationPublishComplex(pub2, 5.6 + -0.67j)
h.helicsPublicationPublishDouble(pub1, 457.234)
h.helicsPublicationPublishInteger(pub4, 1)
h.helicsPublicationPublishNamedPoint(pub7, "Blah Blah", 20.0)
h.helicsPublicationPublishString(pub3, "Mayhem")
pub6Vector = [4.5, 56.5]
h.helicsPublicationPublishVector(pub6, pub6Vector)
time.sleep(0.500)
h.helicsFederateRequestTimeAsync(fed1, 1.0)
returnTime = h.helicsFederateRequestTimeComplete(fed1)
assert returnTime == 1.0
ep2MsgCount = h.helicsEndpointPendingMessages(ep2)
assert ep2MsgCount == 2
ep2HasMsg = h.helicsEndpointHasMessage(ep2)
assert ep2HasMsg == 1
msg2 = h.helicsEndpointGetMessage(ep2)
assert h.helicsMessageGetTime(msg2) == 1.0
assert h.helicsMessageGetString(msg2) == "Hello"
assert h.helicsMessageGetOriginalSource(msg2) == "fed1/Ep1"
assert h.helicsMessageGetSource(msg2) == "fed1/Ep1"
assert h.helicsMessageGetDestination(msg2) == "Ep2"
assert h.helicsMessageGetOriginalDestination(msg2) == "Ep2"
fed1MsgCount = h.helicsFederatePendingMessages(fed1)
assert fed1MsgCount == 1
assert h.helicsFederateHasMessage(fed1) == 1
msg3 = h.helicsFederateGetMessage(fed1)
assert h.helicsMessageGetTime(msg3) == 1.0
assert h.helicsMessageGetString(msg3) == "There"
assert h.helicsMessageGetOriginalSource(msg3) == "fed1/Ep1"
assert h.helicsMessageGetSource(msg3) == "fed1/Ep1"
assert h.helicsMessageGetDestination(msg3) == "Ep2"
assert h.helicsMessageGetOriginalDestination(msg3) == "Ep2"
sub1Updated = h.helicsInputIsUpdated(sub1)
# TODO: figure out why this test is broken
assert sub1Updated is False
# TODO: figure out why this test is broken
assert h.helicsInputLastUpdateTime(sub2) == 0.0
# assert h.helicsInputGetComplex(sub2) == 5.6 - 0.67j
# assert h.helicsInputGetDouble(sub1) == 457.234
# assert h.helicsInputGetInteger(sub4) == 1
sub7PointString, sub7DoubleValue = h.helicsInputGetNamedPoint(sub7)
# assert sub7PointString == "Blah Blah"
assert sub7DoubleValue == 20.0
# assert h.helicsInputGetBoolean(sub5) == True
# assert h.helicsInputGetString(sub3) == "Mayhem"
sub3ValueSize = h.helicsInputGetRawValueSize(sub3)
# assert sub3ValueSize == 6
# assert h.helicsInputGetVector(sub6) == [4.5, 56.5]
h.helicsFederateFinalize(fed1)
h.helicsFederateFinalize(fed2)
h.helicsFederateFree(fed1)
h.helicsFederateFinalize(fed2)
h.helicsFederateFree(fed2)
h.helicsFederateInfoFree(fedInfo2)
h.helicsBrokerDisconnect(broker3)
h.helicsBrokerFree(broker3)
h.helicsCleanupLibrary()
h.helicsCloseLibrary()
import time
import helics as h
# Create broker #
broker = h.helicsCreateBroker("zmq", "", "-f 2 --name=BeamBroker")
isConnected = h.helicsBrokerIsConnected(broker)
if isConnected == 1:
print("Broker created and connected")
fedInfo = h.helicsCreateFederateInfo()
fedName = "BeamFederateReader"
h.helicsFederateInfoSetCoreName(fedInfo, fedName)
h.helicsFederateInfoSetCoreTypeFromString(fedInfo, "zmq")
h.helicsFederateInfoSetCoreInitString(fedInfo, "--federates=1")
# deltat is multiplied for default timedelta of 1 second
h.helicsFederateInfoSetTimeProperty(fedInfo, h.helics_property_time_delta, 1.0)
cfed = h.helicsCreateCombinationFederate(fedName, fedInfo)
print("Subscribing...")
subs_chargingPlugIn = h.helicsFederateRegisterSubscription(
cfed, "BeamFederate/chargingPlugIn", "string")
subs_chargingPlugOut = h.helicsFederateRegisterSubscription(
cfed, "BeamFederate/chargingPlugOut", "string")
print("Waiting Execution Mode...")
h.helicsFederateEnterInitializingMode(cfed)
h.helicsFederateEnterExecutingMode(cfed)
# start execution loop #
timebin = 300
currenttime = 0
for t in range(timebin, timebin * 360 + 1, timebin):
# -*- coding: utf-8 -*-
import os
import helics as h
broker_address = "127.0.0.1:12345"
interface_address = "127.0.0.1:32432"
fedinfo = h.helicsCreateFederateInfo()
h.helicsFederateInfoSetCoreType(fedinfo, h.helics_core_type_zmq)
h.helicsFederateInfoSetCoreInitString(
fedinfo,
f"--federates=1 --broker_address=tcp://{broker_address} --interface=tcp://{interface_address} --loglevel=7",
)
h.helicsFederateInfoSetTimeProperty(fedinfo, h.helics_property_time_delta, 0.5)
fed = h.helicsCreateCombinationFederate("receiver", fedinfo,)
topicA = h.helicsFederateRegisterSubscription(fed, "topicA", "",)
h.helicsFederateEnterExecutingMode(fed)
currenttime = 0
for t in range(5, 10 + 1):
while currenttime < t:
currenttime = h.helicsFederateRequestTime(fed, t)
a = h.helicsInputGetDouble(topicA)
print(f"Received a = {a} at time = {currenttime}")
h.helicsFederateFinalize(fed)
h.helicsFederateFree(fed)
h.helicsCloseLibrary()
def test_python_api1():
broker = h.helicsCreateBroker("zmq", "", "-f 1 --name=mainbroker")
fedinfo = h.helicsCreateFederateInfo()
assert "HelicsFederateInfo()" in repr(fedinfo)
fedinfo.core_name = "TestFederate"
fedinfo.core_type = "zmq"
fedinfo.core_init = "-f 1 --broker=mainbroker"
mFed = h.helicsCreateCombinationFederate("TestFederate", fedinfo)
assert (
"""HelicsCombinationFederate(name = "TestFederate", state = HelicsFederateState.STARTUP, current_time = -9223372036.854776, n_publications = 0, n_subscriptions = 0, n_endpoints = 0, n_filters = 0, n_pending_messages = 0)"""
in repr(mFed))
_ = mFed.register_endpoint("ep1")
_ = mFed.register_global_endpoint("ep2")
pub = mFed.register_publication("publication", h.HELICS_DATA_TYPE_STRING,
"custom-units")
assert """HelicsPublication(name = "TestFederate/publication", type = "string", units = "custom-units", info = "")""" in repr(
pub)
sub = mFed.register_subscription("TestFederate/publication",
"custom-units")
assert (
"""HelicsInput(name = "_input_3", units = "custom-units", injection_units = "", publication_type = "", type = "", target = "TestFederate/publication", info = "")"""
in repr(sub))
assert (
"""{ 'CONNECTION_REQUIRED' = 0, 'CONNECTION_OPTIONAL' = 0, 'SINGLE_CONNECTION_ONLY' = 0, 'MULTIPLE_CONNECTIONS_ALLOWED' = 1, 'BUFFER_DATA' = 0, 'STRICT_TYPE_CHECKING' = 0, 'IGNORE_UNIT_MISMATCH' = 0, 'ONLY_TRANSMIT_ON_CHANGE' = 0, 'ONLY_UPDATE_ON_CHANGE' = 0, 'IGNORE_INTERRUPTS' = 0, 'MULTI_INPUT_HANDLING_METHOD' = 0, 'INPUT_PRIORITY_LOCATION' = -1, 'CLEAR_PRIORITY_LIST' = 1, 'CONNECTIONS' = 0 }"""
in repr(sub.option))
sub.option["CONNECTION_REQUIRED"] = 1
assert sub.option["CONNECTION_REQUIRED"] == 1
mFed.property[h.HELICS_PROPERTY_TIME_DELTA] = 1.0
assert mFed.property[h.HELICS_PROPERTY_TIME_DELTA] == 1.0
sub.set_default(b"hello")
assert sub.bytes == b"hello"
sub.set_default("world")
assert sub.string == "world"
sub.set_default(0)
assert sub.integer == 0
sub.set_default(True)
assert sub.boolean is True
sub.set_default(1.1)
assert sub.double == 1.1
sub.set_default(2 + 1.1j)
assert sub.complex == 2 + 1.1j
sub.set_default([1.0, 2.0, 3.0])
assert sub.vector == [1.0, 2.0, 3.0]
sub.info = "hello world"
assert sub.info == "hello world"
assert (
"""{ 'CONNECTION_REQUIRED' = 0, 'CONNECTION_OPTIONAL' = 0, 'SINGLE_CONNECTION_ONLY' = 0, 'MULTIPLE_CONNECTIONS_ALLOWED' = 1, 'BUFFER_DATA' = 0, 'STRICT_TYPE_CHECKING' = 0, 'IGNORE_UNIT_MISMATCH' = 0, 'ONLY_TRANSMIT_ON_CHANGE' = 0, 'ONLY_UPDATE_ON_CHANGE' = 0, 'IGNORE_INTERRUPTS' = 0, 'MULTI_INPUT_HANDLING_METHOD' = 0, 'INPUT_PRIORITY_LOCATION' = 0, 'CLEAR_PRIORITY_LIST' = 0, 'CONNECTIONS' = 0 }"""
in repr(mFed.publications["TestFederate/publication"].option))
mFed.publications["TestFederate/publication"].option[
"CONNECTION_REQUIRED"] = 1
assert mFed.publications["TestFederate/publication"].option[
"CONNECTION_REQUIRED"] == 1
mFed.enter_executing_mode()
data = "random-data"
mFed.endpoints["TestFederate/ep1"].default_destination = "ep2"
mFed.endpoints["TestFederate/ep1"].info = "information"
assert mFed.endpoints["TestFederate/ep1"].default_destination == "ep2"
assert mFed.endpoints["TestFederate/ep1"].info == "information"
mFed.endpoints["TestFederate/ep1"].send_data(data, "ep2", 1.0)
mFed.publications["TestFederate/publication"].publish("first-time")
assert mFed.request_time(2.0) == 1.0
try:
assert mFed.subscriptions[
"TestFederate/publication"].bytes == b"first-time"
except Exception as _:
# TODO: this does not work as expected
with pt.raises(AssertionError):
assert mFed.subscriptions[
"TestFederate/publication"].bytes == b"first-time"
assert mFed.has_message()
assert mFed.endpoints["TestFederate/ep1"].has_message() is False
assert mFed.endpoints["ep2"].has_message()
message = mFed.endpoints["ep2"].get_message()
assert message.message_id == 55
assert message.is_valid() is True
assert message.data == "random-data"
assert message.raw_data == b"random-data"
assert len(message.raw_data) == 11
assert message.original_destination == ""
assert message.original_source == "TestFederate/ep1"
assert message.source == "TestFederate/ep1"
assert message.time == 1.0
assert (
"""HelicsMessage(source = "TestFederate/ep1", destination = "ep2", original_source = "TestFederate/ep1", original_destination = "", time = 1.0, id = 55, message = "random-data")"""
in repr(message))
message.append("-random")
assert message.data == "random-data-random"
message.data = "random-data"
assert message.raw_data == b"random-data"
message.raw_data = b"random-data-random"
assert message.data == "random-data-random"
message.message_id = 100
message.source = "earth"
message.destination = "moon"
message.original_source = "hello-world"
message.original_destination = "goodbye-world"
message.time = 2.0
assert message.message_id == 100
assert message.source == "earth"
assert message.destination == "moon"
assert message.original_source == "hello-world"
assert message.original_destination == "goodbye-world"
assert message.time == 2.0
assert (
"""<{ 1 = False, 2 = False, 3 = False, 4 = False, 5 = False, 6 = False, 7 = False, 8 = False, 9 = False, 10 = False, 11 = False, 12 = False, 13 = False, 14 = False, 15 = False }>"""
in repr(message.flag))
message.flag[1] = True
assert message.flag[1] is True
mFed.publications["TestFederate/publication"].publish(1)
assert mFed.request_next_step() == 2.0
assert mFed.subscriptions["TestFederate/publication"].string == "1"
mFed.endpoints["TestFederate/ep1"].send_data(message, "ep2")
mFed.endpoints["TestFederate/ep1"].send_data(message, "ep2", 1.0)
mFed.publications["TestFederate/publication"].publish(1 + 2j)
assert mFed.request_next_step() == 3.0
try:
assert mFed.subscriptions["TestFederate/publication"].string == "1+2j"
except AssertionError:
assert mFed.subscriptions["TestFederate/publication"].string == "[1,2]"
mFed.publications["TestFederate/publication"].publish([1, 2, 3, 4, 5])
assert mFed.request_next_step() == 4.0
assert mFed.subscriptions["TestFederate/publication"].vector == [
1.0, 2.0, 3.0, 4.0, 5.0
]
mFed.publications["TestFederate/publication"].publish(False)
assert mFed.request_next_step() == 5.0
assert mFed.subscriptions["TestFederate/publication"].boolean is False
m = mFed.create_message()
assert (
"""HelicsMessage(source = "", destination = "", original_source = "", original_destination = "", time = 0.0, id = 0, message = "")"""
in repr(m))
mFed.info = "hello-world"
assert mFed.info == "hello-world"
m = mFed.endpoints["ep2"].create_message()
assert (
"""HelicsMessage(source = "", destination = "", original_source = "", original_destination = "", time = 0.0, id = 0, message = "")"""
in repr(m))
mFed.finalize()
del mFed
del broker
def test_python_api7():
broker = h.helicsCreateBroker("zmq", "broker", "--federates 1")
fi = h.helicsCreateFederateInfo()
fed = h.helicsCreateCombinationFederate("test1", fi)
_ = fed.register_filter(h.HELICS_FILTER_TYPE_DELAY, "core1SourceFilter")
assert fed.get_filter_by_name(
"core1SourceFilter").name == fed.get_filter_by_index(0).name
fed.set_global("hello", "world")
# TODO: is_async_operation_completed
assert fed.is_async_operation_completed() is False
fed.enter_initializing_mode_async()
fed.enter_initializing_mode_complete()
assert fed.is_async_operation_completed() is False
fed.enter_executing_mode_async()
fed.enter_executing_mode_complete()
assert fed.is_async_operation_completed() is False
fed.request_time_advance(2.0)
assert fed.current_time == 2.0
fed.request_time_async(4.0)
assert fed.current_time == 2.0
fed.request_time_complete()
assert fed.current_time == 4.0
try:
assert fed.query("hello", "world") == "#invalid"
except AssertionError:
assert fed.query("hello", "world") == {
"error": {
"code": 404,
"message": "query not valid"
}
}
fed.local_error(0, "local")
fed.global_error(0, "global")
fed.log_message("error", logging.ERROR)
fed.log_message("warn", logging.WARN)
fed.log_message("info", logging.INFO)
fed.log_message("debug", logging.DEBUG)
fed.log_message("summary", h.HELICS_LOG_LEVEL_SUMMARY)
fed.finalize_async()
fed.finalize_complete()
fed.core.disconnect()
assert fed.core.wait_for_disconnect()
del fed
broker.disconnect()
assert broker.wait_for_disconnect()
del broker
h.helicsCleanupLibrary()
h.helicsCloseLibrary()
def test_python_api2():
broker = h.helicsCreateBroker("zmq", "broker",
"--federates 1 --loglevel 1")
assert broker.is_connected()
broker.set_global("hello", "world")
broker.data_link("hello", "world")
broker.add_destination_filter_to_endpoint("hello", "world")
broker.add_source_filter_to_endpoint("hello", "world")
try:
assert broker.query("hello", "world") == "#invalid"
except AssertionError:
assert broker.query("hello", "world") == {
"error": {
"code": 404,
"message": "query not valid"
}
}
fi = h.helicsCreateFederateInfo()
fi.core_init = "--federates 1"
fi.property[h.HELICS_PROPERTY_INT_LOG_LEVEL] = 2
fed = h.helicsCreateCombinationFederate("test1", fi)
assert "HelicsCore" in repr(fed.core)
assert 'address = "tcp://127.0.0.1' in repr(fed.core)
assert fed.core.is_connected()
fed.core.set_ready_to_init()
assert "n_publications = 0" in repr(fed)
assert "n_subscriptions = 0" in repr(fed)
assert "n_endpoints = 0" in repr(fed)
assert "n_filters = 0" in repr(fed)
assert fed.property["DELTA"] == 1e-09
assert fed.property["PERIOD"] == 0.0
assert fed.property["OFFSET"] == 0.0
assert fed.property["RT_LAG"] == 0.0
assert fed.property["RT_LEAD"] == 0.0
assert fed.property["RT_TOLERANCE"] == 0.0
assert fed.property["INPUT_DELAY"] == 0.0
assert fed.property["OUTPUT_DELAY"] == 0.0
assert fed.property["MAX_ITERATIONS"] == 50
assert fed.property["LOG_LEVEL"] == 2
assert fed.property["FILE_LOG_LEVEL"] == 2
assert fed.property["CONSOLE_LOG_LEVEL"] == 2
fed.property[h.HELICS_PROPERTY_INT_LOG_LEVEL] = 5
fed.separator = "_"
assert fed.separator == "_"
fed.separator = "/"
assert fed.separator == "/"
assert fed.property[h.HelicsProperty.TIME_DELTA] == 1e-09
assert fed.property[h.HelicsProperty.TIME_PERIOD] == 0.0
assert fed.property[h.HelicsProperty.TIME_OFFSET] == 0.0
assert fed.property[h.HelicsProperty.TIME_RT_LAG] == 0.0
assert fed.property[h.HelicsProperty.TIME_RT_LEAD] == 0.0
assert fed.property[h.HelicsProperty.TIME_RT_TOLERANCE] == 0.0
assert fed.property[h.HelicsProperty.TIME_INPUT_DELAY] == 0.0
assert fed.property[h.HelicsProperty.TIME_OUTPUT_DELAY] == 0.0
assert fed.property[h.HelicsProperty.INT_MAX_ITERATIONS] == 50
assert fed.property[h.HelicsProperty.INT_LOG_LEVEL] == 5
assert fed.property[h.HelicsProperty.INT_FILE_LOG_LEVEL] == 5
assert fed.property[h.HelicsProperty.INT_CONSOLE_LOG_LEVEL] == 5
assert fed.property[h.HelicsProperty.TIME_DELTA.value] == 1e-09
assert fed.property[h.HelicsProperty.TIME_PERIOD.value] == 0.0
assert fed.property[h.HelicsProperty.TIME_OFFSET.value] == 0.0
assert fed.property[h.HelicsProperty.TIME_RT_LAG.value] == 0.0
assert fed.property[h.HelicsProperty.TIME_RT_LEAD.value] == 0.0
assert fed.property[h.HelicsProperty.TIME_RT_TOLERANCE.value] == 0.0
assert fed.property[h.HelicsProperty.TIME_INPUT_DELAY.value] == 0.0
assert fed.property[h.HelicsProperty.TIME_OUTPUT_DELAY.value] == 0.0
assert fed.property[h.HelicsProperty.INT_MAX_ITERATIONS.value] == 50
assert fed.property[h.HelicsProperty.INT_LOG_LEVEL.value] == 5
assert fed.property[h.HelicsProperty.INT_FILE_LOG_LEVEL.value] == 5
assert fed.property[h.HelicsProperty.INT_CONSOLE_LOG_LEVEL.value] == 5
assert "'TIME_DELTA' = 1e-09" in repr(fed.property)
assert "'TIME_PERIOD' = 0.0" in repr(fed.property)
assert "'TIME_OFFSET' = 0.0" in repr(fed.property)
assert "'TIME_RT_LAG' = 0.0" in repr(fed.property)
assert "'TIME_RT_LEAD' = 0.0" in repr(fed.property)
assert "'TIME_RT_TOLERANCE' = 0.0" in repr(fed.property)
assert "'TIME_INPUT_DELAY' = 0.0" in repr(fed.property)
assert "'TIME_OUTPUT_DELAY' = 0.0" in repr(fed.property)
assert "'INT_MAX_ITERATIONS' = 50" in repr(fed.property)
assert "'INT_LOG_LEVEL' = 5" in repr(fed.property)
assert "'INT_FILE_LOG_LEVEL' = 5" in repr(fed.property)
assert "'INT_CONSOLE_LOG_LEVEL' = 5" in repr(fed.property)
assert fed.flag[h.HELICS_FLAG_OBSERVER] is False
assert fed.flag[h.HELICS_FLAG_UNINTERRUPTIBLE] is False
assert fed.flag[h.HELICS_FLAG_INTERRUPTIBLE] is True
assert fed.flag[h.HELICS_FLAG_SOURCE_ONLY] is False
assert fed.flag[h.HELICS_FLAG_ONLY_TRANSMIT_ON_CHANGE] is False
assert fed.flag[h.HELICS_FLAG_ONLY_UPDATE_ON_CHANGE] is False
assert fed.flag[h.HELICS_FLAG_WAIT_FOR_CURRENT_TIME_UPDATE] is False
assert fed.flag[h.HELICS_FLAG_RESTRICTIVE_TIME_POLICY] is False
assert fed.flag[h.HELICS_FLAG_REALTIME] is False
assert fed.flag[h.HELICS_FLAG_SLOW_RESPONDING] is False
assert fed.flag[h.HELICS_FLAG_IGNORE_TIME_MISMATCH_WARNINGS] is False
assert fed.flag[h.HELICS_FLAG_TERMINATE_ON_ERROR] is False
assert fed.flag["TERMINATE_ON_ERROR"] is False
fed.flag["TERMINATE_ON_ERROR"] = False
assert fed.flag[h.HELICS_FLAG_OBSERVER.value] is False
assert fed.flag[h.HELICS_FLAG_UNINTERRUPTIBLE.value] is False
assert fed.flag[h.HELICS_FLAG_INTERRUPTIBLE.value] is True
assert fed.flag[h.HELICS_FLAG_SOURCE_ONLY.value] is False
assert fed.flag[h.HELICS_FLAG_ONLY_TRANSMIT_ON_CHANGE.value] is False
assert fed.flag[h.HELICS_FLAG_ONLY_UPDATE_ON_CHANGE.value] is False
assert fed.flag[h.HELICS_FLAG_WAIT_FOR_CURRENT_TIME_UPDATE.value] is False
assert fed.flag[h.HELICS_FLAG_RESTRICTIVE_TIME_POLICY.value] is False
assert fed.flag[h.HELICS_FLAG_REALTIME.value] is False
assert fed.flag[h.HELICS_FLAG_SLOW_RESPONDING.value] is False
assert fed.flag[h.HELICS_FLAG_IGNORE_TIME_MISMATCH_WARNINGS.value] is False
assert fed.flag[h.HELICS_FLAG_TERMINATE_ON_ERROR.value] is False
assert "'OBSERVER' = False" in repr(fed.flag)
assert "'UNINTERRUPTIBLE' = False" in repr(fed.flag)
assert "'INTERRUPTIBLE' = True" in repr(fed.flag)
assert "'SOURCE_ONLY' = False" in repr(fed.flag)
assert "'ONLY_TRANSMIT_ON_CHANGE' = False" in repr(fed.flag)
assert "'ONLY_UPDATE_ON_CHANGE' = False" in repr(fed.flag)
assert "'WAIT_FOR_CURRENT_TIME_UPDATE' = False" in repr(fed.flag)
assert "'RESTRICTIVE_TIME_POLICY' = False" in repr(fed.flag)
assert "'REALTIME' = False" in repr(fed.flag)
assert "'SLOW_RESPONDING' = False," in repr(fed.flag)
assert "'IGNORE_TIME_MISMATCH_WARNINGS' = False," in repr(fed.flag)
assert "'TERMINATE_ON_ERROR' = False" in repr(fed.flag)
fed.flag[h.HELICS_FLAG_TERMINATE_ON_ERROR] = True
assert fed.flag[h.HELICS_FLAG_TERMINATE_ON_ERROR] is True
fed.core.register_filter(h.HelicsFilterType.DELAY, "")
fed.core.register_cloning_filter("")
fed.register_filter(h.HelicsFilterType.DELAY, "")
fed.register_cloning_filter("")
fed.register_global_filter(h.HelicsFilterType.DELAY, "")
fed.register_global_cloning_filter("")
fed.core.set_global("hello", "world")
try:
assert fed.core.query("broker", "something") == "#invalid"
except AssertionError:
assert fed.core.query("broker", "something") == {
"error": {
"code": 400,
"message": "unrecognized broker query"
}
}
fed.add_dependency("hello")
fed.core.disconnect()
assert fed.core.wait_for_disconnect()
del fed
broker.disconnect()
assert broker.wait_for_disconnect()
del broker
h.helicsCleanupLibrary()
h.helicsCloseLibrary()
def create_federate(self, fed_name): self.vfed = h.helicsCreateCombinationFederate(str(fed_name), self.__fedinfo)
