Skip to content

hetalang/heta-compiler

Repository files navigation

Heta project GitHub issues GitHub license status
Autotests Coverage Status GitHub npm CodeQL

Heta-compiler

Heta-compiler is a command-line tool for building and transforming models written in the Heta modeling language.

It combines modular model definitions and exports them to widely used simulation formats such as SBML, SimBiology, and tabular representations.

Heta-compiler is part of the Heta modeling project for quantitative systems pharmacology (QSP) and Systems Biology.

📚 Documentation
https://hetalang.github.io/hetacompiler/

Quick start

The example below shows how to create a simple reaction model and convert it to SBML, Simbiology, and Heta-Table format.

Step 1

Create a new directory called heta-conversion.

Step 2

Create a file index.heta inside the directory with the following content:

comp1 @Compartment .= 1;

A @Species { compartment: comp1 } .= 10;
B @Species { compartment: comp1 } .= 0;
r1 @Reaction { actors: A => 2B } := k1 * A * comp1;

k1 @Const = 1.2e-1;

This model describes a simple reaction converting A to B inside a compartment.

Step 3

Open the terminal (console) and run the following command in the project directory:

heta build --export=SBML,Table,Simbio

The compiler reads the index.heta entry file and generates output files in the dist directory.

Features

  • Modular model development using Heta language
  • Integration of model components from multiple sources (Heta, Excel, JSON/YAML, SBML)
  • Export to popular simulation formats
  • Suitable for automated workflows and CI pipelines
  • CLI tool suitable for scripting and CI pipelines

Installation

Heta Compiler can be installed on major operating systems.
See the installation guide for details.

About Heta

Heta is a domain‑specific modeling language (DSL) for dynamic models used in Quantitative Systems Pharmacology (QSP) and Systems Biology.

Heta-compiler provides a command-line interface and JavaScript API for checking, compilation, and transforming models written in Heta to different formats.

Getting help

Citation

Metelkin, E. (2021). Heta compiler: a software tool for the development of large-scale QSP models and compilation into simulation formats. Journal of Open Source Software, 6(67), 3708. https://doi.org/10.21105/joss.03708

License

Licensed under the Apache License 2.0.
See the LICENSE file for details.

This software is provided "as is", without any warranties or guarantees. Use it at your own risk. The author is not responsible for any issues, data loss, or damages resulting from its use.

Copyright © 2019-2026 Heta project