Exporting a model definition

Recipes record versioned family construction inputs for export and replay.

using Agate.Construction: export_recipe, import_recipe
using Agate.Models: NiPiZD
using OceanBioME: BoxModelGrid

Construct and save

Instead of using construct() by using construct_plus_recipe(), we can generate a recipe alongside the model. The recipe can then be exported to JSON and later reloaded to reconstruct the model.

grid = BoxModelGrid()

bgc, recipe = NiPiZD.construct_plus_recipe(;
    grid,
    size_structure=(;
        phytoplankton=(P=(n=3, min_esd=1.0, max_esd=10.0, spacing=:log),),
        zooplankton=(Z=(n=2, min_esd=20.0, max_esd=100.0, spacing=:linear),),
    ),
)

recipe_path = tempname() * ".json"
export_recipe(recipe_path, recipe)

"/tmp/jl_vub6J8lsTO.json"

The JSON records the family definition version, a SHA-256 content fingerprint, and package provenance. Git repository and commit information are included when the implementation matches a checkout.

println("Wrote model recipe to ", recipe_path)

Wrote model recipe to /tmp/jl_vub6J8lsTO.json

Reload and replay

Runtime choices such as the grid are supplied again when the recipe is replayed.

loaded = import_recipe(recipe_path)
replayed = NiPiZD.construct_from_recipe(loaded; grid)

println("Recipe preserved: ", loaded == recipe)
println("Parameters preserved: ", replayed.parameters == bgc.parameters)

Recipe preserved: true
Parameters preserved: true

This page was generated using Literate.jl.