Skip to main content

Python HELICS bindings

Project description

PyHELICS

Python HELICS bindings

pip install helics

If you wish to get additional functionality in the CLI (experimental), you can install it using the following:

pip install 'helics[cli]'

Documentation

To use the project:

import helics as h
h.helicsGetVersion()

See https://docs.helics.org for more information about how to use HELICS.

This package uses cffi to provide a Python interface to the HELICS C API.

By default, when you install from PyPI, the version number of the package will match the version of HELICS that is installed. For example, if you run the following:

pip install helics

You will also get precompiled binaries of HELICS for your platform if they exist. If they don't exist, a source distribution will attempt to be built and installed. The user can also provide the location of the binaries if they wish to do so. For more information, see https://python.helics.org/installation.

Debugging

Please share the output of the following command when creating an issue:

$ python -c "import helics as h; import json; print(json.dumps(h.helicsGetSystemInfo(), indent=4, sort_keys=True))"

Citation

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

Project details


Release history Release notifications | RSS feed

This version

3.5.3

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

helics-3.5.3.tar.gz (294.0 kB view hashes)

Uploaded Source

Built Distributions

helics-3.5.3-py3-none-win_amd64.whl (14.2 MB view hashes)

Uploaded Python 3 Windows x86-64

helics-3.5.3-py3-none-win32.whl (12.5 MB view hashes)

Uploaded Python 3 Windows x86

helics-3.5.3-py3-none-manylinux2010_x86_64.whl (27.2 MB view hashes)

Uploaded Python 3 manylinux: glibc 2.12+ x86-64

helics-3.5.3-py3-none-macosx_10_14_universal2.macosx_10_14_x86_64.macosx_11_0_arm64.whl (42.7 MB view hashes)

Uploaded Python 3 macOS 10.14+ universal2 (ARM64, x86-64) macOS 10.14+ x86-64 macOS 11.0+ ARM64

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page