HELICS Logo
helics2

Basics

  • Installation
    • Quick start
    • Using an installer for your operating system
    • Using a package manager for your operating system
      • Package Manager
        • Install using conda (Windows, MacOS, Linux)
        • Install using pip (Windows, macOS, Linux, other)
        • Install using Spack (macOS, Linux)
        • Troubleshooting shared library errors on Windows
    • OS Specific installation from source
      • Windows Installation
        • Windows Installers
        • Build Requirements
        • Setup for Visual Studio
        • Testing
        • Building HELICS with python support
        • MSYS2
        • Building with mingw
        • Building with cygwin
      • Mac Installation
        • Requirements
        • Useful Resources
        • Setup
        • Compile and Install
        • Testing HELICS
      • Linux Installations
        • Ubuntu Installation
        • A few Specialized Platforms
      • Docker
        • Requirements
        • Dockerfile
        • Build
        • Run
      • HELICS with language bindings support
        • HELICS with Python3
        • HELICS with Python2
        • HELICS with GCC and Python3
        • HELICS with MATLAB
        • HELICS with Octave
      • Linking with the HELICS Library
        • Language bindings
        • C based project
        • C++98 or C++03
        • C++14
        • Troubleshooting shared library errors on Windows
        • Summary
      • HELICS CMake options
        • Main Options
        • Advanced Options
        • Hidden Options
  • Introduction
    • Hello World
    • Python Example
    • Java Minimal Example
    • MATLAB
      • Prerequisites
      • Building HELICS with MATLAB extension
      • Build SWIG MATLAB source
      • Compile MATLAB extension
      • Test HELICS MATLAB extension
    • Terminology
    • Types of Federates
    • Value vs Message
    • Filters
      • Federation
      • Example with delay
      • Example with communication system
    • Interfacing with HELICS
    • Endpoints
    • Inputs
    • Publications
  • User Guide
    • Who Is This User Guide For?
    • User Guide Overview
    • Additional Resources
  • 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
    • Buildings

Reference

  • Federate Configuration
    • Federate Configuration
      • Federate Name
      • Core information
        • Core name
        • Core type
        • Coreinitstring
      • Timing information
      • Interface configuration
        • Notes
    • Message Federates
      • API calls
        • file configuration
    • Value Federates
      • API calls
        • File configuration
        • Notes
    • Filters
      • Filter Creation
      • predefined filters
        • reroute
        • delay
        • randomdelay
        • randomdrop
        • clone
        • firewall
        • custom filters
    • Federate Timing
      • Timing Parameters
        • Period and Offset
        • minTimeDelta
        • Input Delay
        • Output Delay
        • rt_lag
        • rt_lead
      • Timing Flags
        • uninterruptible
        • source_only
        • observer
        • rollback (not used)
        • only_update_on_change
        • only_transmit_on_change
        • wait_for_current_time_update
        • realtime
        • restrictive-time-policy
    • Federate info
      • Timing control variables
      • Timing flags
      • Other Controls
    • Federate flags
      • single_thread_federate
      • ignore_time_mismatch_warnings
      • connections_required
      • connections_optional
      • strict_input_type_checking
      • slow_responding
      • debugging
      • terminate on error
    • Core Types
      • Test
      • Interprocess
      • ZMQ
      • ZMQ_SS
      • UDP
      • TCP
      • TCP_SS
      • MPI
  • Apps
    • Recorder
      • Command line arguments
      • config file detail
        • subscriptions
        • JSON configuration
        • output
        • Map file output
    • Player
      • Command line arguments
      • Config File Detail
        • publications
        • Messages
        • JSON configuration
    • Source
      • Command line arguments
      • Config File Detail
        • publications
        • Messages
        • JSON configuration
    • helics_app
      • Echo
      • Player
      • Recorder
      • Tracer
      • Source
      • Broker
      • Clone
      • MultiBroker
    • Command Line Arguments
    • Echo
      • Command line arguments
    • Tracer
      • Command line arguments
      • Config File Detail
        • subscriptions
        • JSON configuration
    • Broker
      • Command line arguments
    • Broker Server
      • Command line arguments
    • Clone
      • Command line arguments
        • output

API Docs

  • C API Reference
    • Enum
    • Functions
      • Broker
      • Core
      • Endpoint
      • FederateInfo
      • Federate
      • Filter
      • Input
      • Message
      • Publication
      • Query
      • Others
  • C++ API Reference (Doxygen)

Contributing

  • 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
      • Travis-CI Tests
        • Push Tests
        • PR tests and develop branch Tests
        • Daily Builds on develop
      • Appveyor tests
      • Azure tests
      • Circle CI
        • Benchmark tests
      • Drone
      • Cirrus CI
      • Read the docs
      • Codacy
    • Public API
  • RoadMap
    • [2.8] ~ 2021-06-15
    • [3.0] ~ 2021-05-05 Beta, Final release approximately a month later
    • [3.1] ~ 2021-07-15
HELICS
  • »
  • Search

© Copyright Copyright (c) 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 . Revision 12aab952.

Built with Sphinx using a theme provided by Read the Docs.