If you’re having trouble with understanding what HELICS does, how to use HELICS, getting a specific feature to work, or trouble-shooting some aspect of a HELICS-based co-simulation; there are a variety of support mechanisms we offer.
- Documentation - Though you’re already here at the documentation site, the following pages may be of particular interest:
- Installation Guide - Help with getting HELICS installed with the correct options for your particular use case
- User Guide - Comprehensive guide to understanding and using HELICS covering both the fundamentals as well as more advanced topics.
- API reference - HELICS is written in C++ with many supported language bindings. The C++ Doxygen is the most comprehensive reference for the HELICS API
- User Forum (forthcoming) - Once Github moves their forums feature out of beta we’ll implement it to provide a space where user’s can discuss their HELICS use cases and get support on how to use HELICS.
- Bug Reports/Support - If HELICS doesn’t appear to be working as expected, this is the place to file a bug report and get some help.
- Examples, Use Cases, and Tutorials - Over the years there have been a number of different public examples, use cases, and demonstrations of HELICS. These may be useful to show how particular features work or as a starting point for your use of HELICS.
- YouTube Channel - HELICS developers have created a number of short lectures and tutorials about how HELICS works and how to use it.
- Gitter - Live chat with developers (when they’re logged in) for quick fix support.
- Virtual Office Hours - HELICS developers have periodic open office hours where anybody can come and get hands-on help with understanding HELICS better or getting a particular feature to work. Contact email@example.com for an invitation.
- Using the web interface - Using the webserver, HELICS also has a built-in web interface for running, monitoring, and diagnosing co-simulations.
- (Termination) Logging - Discussion of logging within HELICS and how to control it.