HELICS Logo
latest
  • User Guide
    • Orientation
    • HELICS Installation
      • Installing the Pre-Compiled Libraries
      • Install using Spack (macOS, Linux)
      • OS Specific installation from source
        • Windows Installation
        • Mac Installation
        • Linux Installations
        • Docker
        • HELICS with language bindings support
        • Linking with the HELICS Library
        • HELICS CMake options
      • Package Manager
        • Install using pip (Windows, macOS, Linux, other)
        • Install using Spack (macOS, Linux)
        • Troubleshooting shared library errors on Windows
      • HELICS Installation Methods
        • Build from source
        • Python via pip install
        • matHELICS install
        • Julia install
        • jHELICS
        • nimble install
        • C# install
        • Download pre-compiled
        • spack install
      • HELICS runner
    • HELICS User Tutorial
      • Co-Simulation Overview
      • Fundamental Topics
        • HELICS Terminology
        • Federates
        • Federate Interface Configuration
        • Timing Configuration
        • Co-simulation Stages
        • Logging
        • Running HELICS Co-Simulations
        • HELICS Web Interface
        • Integration of Federates
      • Advanced Topics
        • Multi-Source Inputs
        • Co-simulation Architectures
        • Queries
        • Interacting with a Running Simulation
        • Core Types
        • Multi-Protocol Broker
        • Broker Hierarchies
        • Environment variables
        • Simultaneous Co-simulations
        • Multi-Computer Co-simulations
        • Orchestration for HPC systems
        • Terminating HELICS
        • Profiling
        • Targeted Endpoints
        • Dynamic Federations
        • Timeouts
        • Command Interface
        • Iteration
        • Aliases
        • Callbacks
        • Callback Federates
        • Configuration in Complex Networks
        • Encrypted Communication
    • Examples
      • Fundamental Examples
        • Base Example Co-Simulation
        • Federate Integration with PyHELICS API
        • Federate Message + Communication Configuration
      • Advanced Examples
        • Default Advanced Example
        • Brokers - Simultaneous Co-simulations
        • Brokers - Hierarchies
        • Brokers - Multi-Protocol Brokers
        • Brokers - Multi-computer Co-simulation
        • Federation Queries
        • Multi-Input
        • Monte Carlo Co-Simulations
        • Iteration
      • Examples in Supported Languages
        • User Guide Advanced Default Example
        • Other Examples
    • Support
  • Developer Guide
    • Style Guide
      • Naming Conventions
    • Generating SWIG extension
    • Run tests
    • Generating Documentation
    • HELICS Benchmarks
      • Baseline benchmarks
        • ActionMessage
        • Conversion
      • Simulation Benchmarks
        • Echo
        • Echo_c
        • Echo Message
        • Filter
        • Ring Benchmark
        • Ring Message Benchmark
        • Timing Benchmark
      • Message Benchmarks
        • MessageLookup
        • MessageSend
      • Standardized Tests
        • PHold
      • Multinode Benchmarks
    • Description of the different continuous integration test setups running on the CI servers
      • Appveyor tests
      • Azure tests
      • Circle CI
        • Benchmark tests
      • GitHub Actions
      • Drone
      • Cirrus CI
      • Read the docs
      • Codacy
    • (Planned) CI/CD Infrastructure
      • Continuous Integration
        • Linux
        • Windows
        • macOS
        • ARM
        • FreeBSD
        • Valgrind [daily]
        • Code Coverage [daily]
        • Sanitizers
        • Documentation
      • Static Analysis, Linting, and Automatted Code Maintenance
        • pre-commit
        • Updating generated interface files and docs
      • Automated Releases
      • Multinode Tests and Benchmarks
      • Community Server
    • Porting Guide: HELICS 2 to 3
      • Dependency changes
      • Code changes
        • PRs with breaking changes
        • Application API (C++17)
        • Command line interfaces
        • C Shared API
        • C++98 API (wrapper around the C Shared API)
        • Queries
        • Libraries
        • CMake
    • Public API
    • RoadMap
      • [3.5] ~ Summer 2023
      • Nearer term features
      • Further in the future
    • HELICS Type Conversions
      • Available types
        • Invalid Values
      • How types are used in HELICS
        • Interface specification
        • Data publication and extraction
      • Data Representation
      • Data conversions
        • Conversion from Double
        • Conversion from INT
        • Conversion from String
        • Conversion from vector double
        • Conversion from Complex Vector
        • Conversion from Complex
        • Conversion from a Named Point
        • Conversion from Bool
        • Conversion from Time
      • Unit conversions
    • Other notes for developers
  • References
    • Tools with HELICS Support
      • Power Systems Tools
        • Electric Distribution System Simulation
        • Electric Transmission System Simulation
        • Real time simulators
        • Electric Power Market simulation
        • Contingency Analysis tools
      • Communication Tools
      • Gas Pipeline Modeling
      • Optimization packages
      • Transportation modeling
    • Built-In HELICS Apps
      • Recorder
        • Command line arguments
        • config file detail
      • Player
        • Command line arguments
        • Config File Detail
      • Source
        • Command line arguments
      • helics_app
        • Echo
        • Player
        • Recorder
        • Tracer
        • Source
        • Broker
        • Clone
        • MultiBroker
      • Command Line Arguments
      • Echo
        • Command line arguments
      • Tracer
        • Command line arguments
        • Config File Detail
      • Broker
        • Command line arguments
      • Broker Server
        • Command line arguments
      • Clone
        • Command line arguments
    • Configuration Options Reference
      • Configuration methods
        • Choosing configuration method
        • How to Use This Reference
      • Sample Configurations
      • General Federate Options
        • name | -n (required)
        • core_type | coretype | coreType | -t [“zmq”]
        • core_name | corename | coreName []
        • core_init_string | coreinitstring | coreInitString | -i []
        • autobroker [false]
        • broker_init_string | brokerinitstring | brokerInitString [“”]
        • terminate_on_error | terminateonerror | terminateOnError [false]
        • source_only | sourceonly | sourceOnly [false]
        • observer [false]
      • Logging Options
        • log_file | logfile | logFile []
        • log_level | loglevel | logLevel [0]
        • file_log_level | fileloglevel | fileLogLevel [null]
        • console_log_level | consoleloglevel | consoleLogLevel [null]
        • force_logging_flush | forceloggingflush | forceLoggingFlush [false]
        • dump_log | dumplog | dumpLog [false]
        • logbuffer | log_buffer | logBuffer [10]
      • Other Options
      • indexgroup | index_group | indexGroup [0]
      • Timing Options
        • ignore_time_mismatch | ignoretimemismatch | ignoreTimeMismatch [false]
        • uninterruptible [false]
        • period [0]
        • offset [0]
        • time_delta | timeDelta | timedelta [1ns]
        • input_delay | inputdelay | inputDelay [0]
        • output_delay | outputdelay | outputDelay [0]
        • real_time | realtime | realTime [false]
        • rt_lag| rtlag | rtLag [0.2] and rt_lead | rtlead | rtLead [0.2]
        • rt_tolerance | rttolerance | rtTolerance [0.2]
        • wait_for_current_time_update |waitforcurrenttimeupdate | waitForCurrentTimeUpdate [false]
        • restrictive_time_policy | restrictivetimepolicy | restrictiveTimePolicy [false]
        • slow_responding | slowresponsing | slowResponding [false]
        • event_triggered [false]
      • Iteration
        • forward_compute | forwardcompute | forwardCompute [false]
        • rollback [false]
        • max_iterations | maxiterations | maxIteration [50]
      • General and Per Subscription, Input, or Publication
        • only_update_on_change | onlyupdateonchange | onlyUpdateOnChange [false] and only_transmit_on_change | onlytransmitonchange | onlyTransmitOnChange [false]
        • tolerance
        • default
        • connection_required | connectionrequired | connectionRequired [false]
        • connection_optional | connectionoptional | connectionOptional [false]
      • Subscription, Input, and/or Publication Options
        • key (required)
        • type [null]
        • unit [null]
        • global [false]
        • buffer_data | bufferdata | bufferData [false]
        • ignore_units_mismatch | ignoreunitmismatch | ignoreUnitMismatch [null]
        • info [“”]
        • strict_input_type_checking | strictinputtypechecking | strictInputTypeChecking [false]
      • Publication-only Options
        • targets
      • Input-only Options
        • targets
        • connections []
        • input_priority_location | inputprioritylocation | inputPriorityLocation []
        • clear_priority_list | clearprioritylist | clearPriorityList [false]
        • single_connection_only | singleconnectiononly |singleConnectionOnly [false]
        • multiple_connections_allowed | multipleconnectionsallowed | multipleConnectionsAllowed [true]
        • multi_input_handling_method | multiinputhandlingmethod | multiInputHandlingMethod [none]
      • Endpoint Options
        • name (required)
        • type []
        • destination | target []
        • alias []
        • subscriptions []
        • filters [null]
        • info [“”]
      • Filter Options
        • name []
        • source_targets, sourcetargets, sourceTargets []
        • destination_targets, destinationtargets, destinationtargets []
        • info [“”]
        • operation []
      • Profiling
        • profiling [false]
        • profiler [“”]
        • local_profiling_capture [false]
        • profiling_marker [false]
      • Network
        • interface network
        • reuse_address | reuseaddress | reuseAddress [false]
        • noack_connect | noackconnect | noackConnect [false]
        • max_size | maxsize | maxSize[4096]
        • max_count | maxcount | maxCount [256]
        • network_retries | networkretries | networkRetries [5]
        • encrypted [false]
        • encryption_config
        • use_os_port | useosport | useOsPort [false]
        • client or server [null]
        • local_interface | localinterface | localInterface [local address]
        • broker_address | brokeraddress | brokerAddress []
        • broker_port | brokerport | brokerPort []
        • broker_name | brokername | brokerName []
        • local_port | localport | localPort []
        • port_start | portstart | portStart []
        • force []
    • API Reference
      • C API Reference
        • Table of Contents
        • Enums
      • C++ API (doxygen)
      • C API
      • Python API
      • matHELICS API
      • Julia API
      • REST Queries API
  • Quick links
    • Configuration Options Reference
      • Configuration methods
        • Choosing configuration method
        • How to Use This Reference
      • Sample Configurations
      • General Federate Options
        • name | -n (required)
        • core_type | coretype | coreType | -t [“zmq”]
        • core_name | corename | coreName []
        • core_init_string | coreinitstring | coreInitString | -i []
        • autobroker [false]
        • broker_init_string | brokerinitstring | brokerInitString [“”]
        • terminate_on_error | terminateonerror | terminateOnError [false]
        • source_only | sourceonly | sourceOnly [false]
        • observer [false]
      • Logging Options
        • log_file | logfile | logFile []
        • log_level | loglevel | logLevel [0]
        • file_log_level | fileloglevel | fileLogLevel [null]
        • console_log_level | consoleloglevel | consoleLogLevel [null]
        • force_logging_flush | forceloggingflush | forceLoggingFlush [false]
        • dump_log | dumplog | dumpLog [false]
        • logbuffer | log_buffer | logBuffer [10]
      • Other Options
      • indexgroup | index_group | indexGroup [0]
      • Timing Options
        • ignore_time_mismatch | ignoretimemismatch | ignoreTimeMismatch [false]
        • uninterruptible [false]
        • period [0]
        • offset [0]
        • time_delta | timeDelta | timedelta [1ns]
        • input_delay | inputdelay | inputDelay [0]
        • output_delay | outputdelay | outputDelay [0]
        • real_time | realtime | realTime [false]
        • rt_lag| rtlag | rtLag [0.2] and rt_lead | rtlead | rtLead [0.2]
        • rt_tolerance | rttolerance | rtTolerance [0.2]
        • wait_for_current_time_update |waitforcurrenttimeupdate | waitForCurrentTimeUpdate [false]
        • restrictive_time_policy | restrictivetimepolicy | restrictiveTimePolicy [false]
        • slow_responding | slowresponsing | slowResponding [false]
        • event_triggered [false]
      • Iteration
        • forward_compute | forwardcompute | forwardCompute [false]
        • rollback [false]
        • max_iterations | maxiterations | maxIteration [50]
      • General and Per Subscription, Input, or Publication
        • only_update_on_change | onlyupdateonchange | onlyUpdateOnChange [false] and only_transmit_on_change | onlytransmitonchange | onlyTransmitOnChange [false]
        • tolerance
        • default
        • connection_required | connectionrequired | connectionRequired [false]
        • connection_optional | connectionoptional | connectionOptional [false]
      • Subscription, Input, and/or Publication Options
        • key (required)
        • type [null]
        • unit [null]
        • global [false]
        • buffer_data | bufferdata | bufferData [false]
        • ignore_units_mismatch | ignoreunitmismatch | ignoreUnitMismatch [null]
        • info [“”]
        • strict_input_type_checking | strictinputtypechecking | strictInputTypeChecking [false]
      • Publication-only Options
        • targets
      • Input-only Options
        • targets
        • connections []
        • input_priority_location | inputprioritylocation | inputPriorityLocation []
        • clear_priority_list | clearprioritylist | clearPriorityList [false]
        • single_connection_only | singleconnectiononly |singleConnectionOnly [false]
        • multiple_connections_allowed | multipleconnectionsallowed | multipleConnectionsAllowed [true]
        • multi_input_handling_method | multiinputhandlingmethod | multiInputHandlingMethod [none]
      • Endpoint Options
        • name (required)
        • type []
        • destination | target []
        • alias []
        • subscriptions []
        • filters [null]
        • info [“”]
      • Filter Options
        • name []
        • source_targets, sourcetargets, sourceTargets []
        • destination_targets, destinationtargets, destinationtargets []
        • info [“”]
        • operation []
      • Profiling
        • profiling [false]
        • profiler [“”]
        • local_profiling_capture [false]
        • profiling_marker [false]
      • Network
        • interface network
        • reuse_address | reuseaddress | reuseAddress [false]
        • noack_connect | noackconnect | noackConnect [false]
        • max_size | maxsize | maxSize[4096]
        • max_count | maxcount | maxCount [256]
        • network_retries | networkretries | networkRetries [5]
        • encrypted [false]
        • encryption_config
        • use_os_port | useosport | useOsPort [false]
        • client or server [null]
        • local_interface | localinterface | localInterface [local address]
        • broker_address | brokeraddress | brokerAddress []
        • broker_port | brokerport | brokerPort []
        • broker_name | brokername | brokerName []
        • local_port | localport | localPort []
        • port_start | portstart | portStart []
        • force []
    • Queries
      • Targets
      • Query String
        • Federate Queries
        • Local Federate Queries
        • Core queries
        • Broker Queries
      • Usage Notes
      • Error Handling
        • Application API
        • C API and interface API’s
      • Timeouts
      • Example
    • Environment variables
      • Federate environment variables
      • Core and Broker environment variables
      • Networking environment variables
      • Environment variables used in the Web server
    • C API Reference
      • Table of Contents
      • Enums
        • General
        • Creation
        • Broker
        • Core
        • FederateInfo
        • Federate
        • ValueFederate
        • Publication
        • Input
        • MessageFederate
        • Endpoint
        • Message
        • FilterFederate
        • Filter
        • Query
    • HELICS CMake options
      • Main Options
      • Advanced Options
        • HELICS Configuration options
        • Build configuration Options
      • Hidden Options
    • Built-In HELICS Apps
      • Recorder
        • Command line arguments
        • config file detail
      • Player
        • Command line arguments
        • Config File Detail
      • Source
        • Command line arguments
      • helics_app
        • Echo
        • Player
        • Recorder
        • Tracer
        • Source
        • Broker
        • Clone
        • MultiBroker
      • Command Line Arguments
      • Echo
        • Command line arguments
      • Tracer
        • Command line arguments
        • Config File Detail
      • Broker
        • Command line arguments
      • Broker Server
        • Command line arguments
      • Clone
        • Command line arguments
HELICS
  • »
  • Developer Guide
  • Edit on GitHub

Developer Guide¶

  • Style Guide
  • Generating SWIG extension
  • Run tests
  • Generating Documentation
  • HELICS Benchmarks
  • Description of the different continuous integration test setups running on the CI servers
  • (Planned) CI/CD Infrastructure
  • Porting Guide: HELICS 2 to 3
  • Public API
  • RoadMap
  • HELICS Type Conversions
  • Other notes for developers
Previous Next

© Copyright 2017-2021 Battelle Memorial Institute; Lawrence Livermore National Security, LLC; Alliance for Sustainable Energy, LLC. See the top-level NOTICE for additional details. All rights reserved. SPDX-License-Identifier: BSD-3-Clause. Documentation source in https://github.com/GMLC-TDC/HELICS. Revision 0b3d894e. Last updated on Jul 11, 2023.

Built with Sphinx using a theme provided by Read the Docs.
Read the Docs v: latest
Versions
latest
v3_user_guide_edits
main
helics2
docs_v3.3
develop
Downloads
pdf
html
epub
On Read the Docs
Project Home
Builds