Version: v0.0.1

plan

Stable function · The planner

Tier: stable · Kind: function · Topic: The planner

JuliaRust
planearthsci_integrator_planner::plan

Julia

plan(config_path::AbstractString; tspan, backend)
plan(config_path; tspan=nothing, backend=DiffBackend()) -> draft

Plan the run config at config_path (spec/plan.md): read and flatten its model, run passes 1–4, check and resolve the schedule and the settings, and resolve strategies, then derive the documents and validate them. tspan is the caller’s run interval (§7.2), a pair of numbers or of RFC 3339 UTC timestamps. A refusal is a PlannerRefusal ; a part of the plan that needs EarthSciASTDiff, with a backend that cannot give it (a test backend), is a PlannerStageError . Write the result with write_plan .

Source

Rust

pub fn plan(path: &Path, options: &Options, bands: &dyn BandSource) -> Result<Planned>

Plans the run config at path. bands gives each term’s band list (§5.2.2); astdiff::AstDiffBands is EarthSciASTDiff’s.

Source · Rust docs