Further reading¶
This site documents this bridge. The links below are the upstream resources a maintainer will actually want open in a second tab – official manuals for the machinery we embed, the packaging tools we build with, and the domain references behind the validation problems. Each entry says which page of ours it backs. (A local mirror of some of these documents sits in this repository’s main checkout for offline work, but it is untracked and never published, so every link here goes to the live upstream source.)
Embedding Julia from C¶
- Embedding Julia – the Julia manual –
the canonical reference for
jl_init, GC roots (JL_GC_PUSH),jl_call, and thejulia-config.jlembed flow. Everything in bridge internals is built on this page plus thejulia.hheader. - The Julia documentation – start here for the language semantics the Julia-side package relies on.
- juliaup – the version manager
whose auto-updating shims motivated the pinning discipline of
Lessons. Read its channel documentation before pointing
any build at a
juliathat is really a shim.
PackageCompiler: sysimages and AOT libraries¶
- PackageCompiler.jl documentation – the manual behind both rebuild recipes of rebuild from zero.
- Sysimages –
what
create_sysimagetraces and bakes; why an image is pinned to one Julia build and onecpu_target. - Building libraries –
create_library,Base.@ccallable, and theinit_juliacontract the AOT examples follow. - PackageCompiler.jl repository –
issues and release notes; where the
include_lazy_artifactsbehavior is tracked.
The SciML stack behind the chemistry¶
- DifferentialEquations.jl documentation –
the solver suite; the per-cell
reinit!/step!pattern whose performance regression is Lessons entry 2. - Catalyst.jl documentation – the reaction-network modeling layer in the pinned stack.
- OrdinaryDiffEq.jl and
SciMLBase.jl – the solver and
problem-interface packages whose
[compat]pins are load-bearing. - SciML – the ecosystem’s overview site.
Domain references for the validation problems¶
- GRI-Mech 3.0 – the 53-species, 325-reaction natural-gas combustion mechanism behind the ignition-delay benchmark of acceptance gates.
- Cantera – the YAML mechanism format ChemMechSim loads; the reference toolchain for cross-checking mechanism data.
- Clawpack – conservation-law / finite-volume methods; the intellectual home of the wave-propagation solver the reacting-flow capstone builds on.
Tooling adjacent to this repository¶
- Preferences.jl – how Julia packages persist per-environment settings; relevant whenever build behavior differs between environments.
- Documenter.jl – the standard Julia documentation generator; the reference point for comparing conventions with this MkDocs site.
Where to go next¶
Nothing downstream – you have reached the reference shelf. Back to the developer guide, or to the site’s own validation story.