Docs

Model components, top to bottom.

[kalix] Run settings — timestep, start and end dates, model version. [inputs] Input data series the model can reference. [constants] Named fixed values reused across nodes.

[node.*] The network — 13 node types.

InInflowFlow into the network GrGR4JRainfall-runoff model ScSacramentoSoil-moisture accounting StStorageReservoirs & weirs RtRoutingChannel routing CfConfluenceMerge branches SpSplitterSplit flow LoLossChannel losses RURegulated UserOrdered extraction UUUnregulated UserCapped extraction GaGaugeRecord flow OCOrder ControlManage orders BhBlackholeTerminate flow

[outputs] Results and series written out at the end of a run.

Using Kalix

▦

KalixIDE

The desktop modelling environment — editor, map, plots and runs.

OverviewEditor & lintingPlotting & statsRun Manager

›_

Kalix CLI

Run models headless from the commandline — scriptable and CI-ready.

OverviewRunning modelsBenchmarkingOptimisation

py

Kalix in Python

Drive Kalix from a notebook or script via the Python package.

OverviewLoading & runningOptimisationPixie datasets

Deep topics

Concepts, optimisation, reference and developer material.

docs/

├─ concepts/

│  ├─ Model File Structure  how a .ini model is organised

│  ├─ Conventions  naming, units and sign rules

│  ├─ Ordering  how orders propagate upstream

│  ├─ Dynamic Expressions  formulas in model properties

│  ├─ Parameter types  scalars, series and tables

│  └─ Data cache  how results are stored and reused

├─ optimisation/

│  ├─ Objective functions  defining fitness terms

│  └─ Algorithms  SCE, CMA-ES, DE, DREAM

└─ reference/

   ├─ Glossary  terms and definitions

   └─ Technical Reference  GR4J, Sacramento, solvers