HELICS.jl

HELICS.jl is a cross-platform Julia wrapper around the HELICS library.

This package is now available for Windows, Mac, and Linux.

The documentation for the development latest of this package is here.

Use the Julia package manager to install HELICS.jl

julia> ]
(v1.1)> add HELICS

Open the package manager REPL (using ])

To install the latest development version, use the following from within Julia:

(v1.1) pkg> add HELICS#master

This package includes HELICS as a library. You do not have to install HELICS separately.

Note that this should work on 64-bit Windows, Mac and Linux systems.

If you wish to develop HELICS.jl you may want to use the following:

(v1.1) pkg> dev HELICS

You can also get a specific version,

(v1.1) pkg> add HELICS#33c98625

or specific branch,

(v1.1) pkg> add HELICS#kd/some-new-feature

if these features haven't been merged to master yet.

This package interfaces with HELICS, so a good understanding of HELICS will help troubleshooting. There are plenty of useful resources located here.

If you are having issues using this Julia interface, feel free to open an issue on GitHub here.

General citation for HELICS: T. Hardy, B. Palmintier, P. Top, D. Krishnamurthy and J. Fuller, "HELICS: A Co-Simulation Framework for Scalable Multi-Domain Modeling and Analysis," in IEEE Access, doi: 10.1109/ACCESS.2024.3363615, available at https://ieeexplore.ieee.org/document/10424422

This work was initially developed as an extension to work done as part of the Scalable Integrated Infrastructure Planning (SIIP) initiative at the U.S. Department of Energy's National Renewable Energy Laboratory (NREL).

HELICS.jl is distributed under the terms of the BSD-3 clause license. All new contributions must be made under this license. LICENSE

SPDX-License-Identifier: BSD-3-Clause