Julia Interface Documentation#

Caution

The Julia API is an experimental part of Cantera and may be changed or removed without notice.

The Julia interface is in preview and still missing many features needed for parity with the C++ and Python interfaces. The interface is written in Julia and relies on code generation based on Cantera CLib. It calls libcantera through Julia’s built-in ccall.

Installation and Examples#

To install, follow the steps outlined in the development reference. Examples can be run with

julia --project=interfaces/julia interfaces/julia/examples/X.jl

where X is the name of an example, for example

julia --project=interfaces/julia interfaces/julia/examples/basic.jl

A gallery of the same examples is available under Julia Examples.

API Reference#

The docstrings in interfaces/julia/src document every type and function exported by Cantera.jl. They are also available from the Julia REPL help mode by typing ? followed by a name.

Note

For current information on the state of the Julia API, refer to GitHub issues and enhancement requests, specifically: