Integrate with Julia

Wire InfraStore.jl to the native library. For API usage once it loads, see the Julia Developer Guide.

Prerequisites

Julia 1.10 or newer.
The system libraries (HDF5, NetCDF, Protobuf).

1. Build the Native Library

InfraStore.jl calls into the C ABI cdylib, so build it first:

cargo build -p infrastore-ffi --release

2. Point Julia at the Library

InfraStore.jl resolves the cdylib at first use, in this order:

The INFRASTORE_LIB environment variable — the development override, pointing at a build from step 1.
The InfraStore_jll binary package, if it is installed in the active environment.

For a development build, export the variable (add it to your shell profile to make it permanent):

export INFRASTORE_LIB=$PWD/target/release/libinfrastore_ffi.dylib  # .so on Linux

using InfraStore always works; the resolution happens on the first call that reaches the native library. If neither source yields a path, that call errors (see Troubleshooting). With InfraStore_jll installed you can skip the export entirely — set INFRASTORE_LIB only when you want your local build to win over the JLL.

3. Instantiate and Test the Package

julia --project=julia/InfraStore.jl -e 'using Pkg; Pkg.instantiate()'
julia --project=julia/InfraStore.jl julia/InfraStore.jl/test/runtests.jl

4. Use It From Your Project

Develop the package into your own environment, then activate it with the library variable set:

using Pkg
Pkg.develop(path="/path/to/infrastore/julia/InfraStore.jl")

Smoke Test

using Dates, InfraStore

store = Store(in_memory=true)
ts = SingleTimeSeries(DateTime(2024, 1, 1), Hour(1), collect(100.0:123.0), "load")
key = add_time_series!(
    store,
    42,
    "Generator",
    Component,
    ts;
    features=Dict("model_year" => 2030),
    units="MW",
)
got = get_time_series(store, key)
@assert got.data == ts.data
@assert got.name == "load"
println("ok")

Troubleshooting

Could not locate libinfrastore_ffi. Set the INFRASTORE_LIB environment variable to a built cdylib, or install InfraStore_jll. — Neither resolution path produced a library. Export the variable (step 2) before the first store call, in the same shell that launched Julia, or add InfraStore_jll to the environment.
could not load library — Check the path exists and has the right extension for your OS (.dylib on macOS, .so on Linux, .dll on Windows), and that you built with --release if your variable points at target/release.
InvalidParameterError on add — owner_id must be an integer (e.g. 42, an Int64), and features values must be JSON scalars.

infrastore Documentation