Public API Index
This is a task-oriented index of supported names exported by Cropbox. Deprecated compatibility aliases are intentionally omitted. “Advanced” means that ordinary crop-model scripts rarely need the name, not that it is private.
Modeling and configuration
| Name | Role | Reference |
|---|---|---|
@system | declare a system type | Declarations and Configuration |
System | common abstract system type | System |
@config, Config | build and store configuration | Declarations and Configuration |
parameters | list configurable values | Inspection |
Controller | make a composed system executable | Systems and Composition |
Context | carry configuration and shared runtime state | Model Execution |
Clock, Calendar | elapsed and civil time | Model Execution |
instance | construct and initialize a system | Simulation |
update! | perform one manual update | Simulation |
Simulation, analysis, and visualization
| Name | Role | Reference |
|---|---|---|
simulate, simulate! | run fresh or existing systems | Simulation |
evaluate | compare observations and estimates | Simulation |
calibrate | search parameter bounds | Simulation |
visualize, visualize! | visualize existing data or simulation results | Visualization |
manipulate | add interactive parameter widgets | Visualization |
look, @look, dive | inspect declarations and instances | Inspection |
Values, units, and equations
| Name | Role | Reference |
|---|---|---|
value | unwrap a state or supported wrapper | Values and Units |
nounit | pass a state magnitude without its unit | Values and Units |
unitfy, deunitfy | attach, convert, strip, or parse units | Values and Units |
u"..." | Unitful unit string macro | Built-in Model Components |
± | Normal sampling specification | Configure Models and Scenarios |
⩵ | residual equality for solver behaviors | Behaviors and Tags |
wrap | pass a state object as a dependency (advanced) | Behaviors and Tags |
Dynamic structures
| Name | Role | Reference |
|---|---|---|
produce | request dynamic child construction | Dynamic Hierarchies |
Gather | traversal state and output store | Dynamic Hierarchies |
gather!, visit! | dispatch and walk a model hierarchy | Dynamic Hierarchies |
Reusable systems and re-exports
| Name | Role | Reference |
|---|---|---|
GrowingDegree | threshold temperature response | Built-in Model Components |
BetaFunction | asymmetric normalized temperature response | Built-in Model Components |
Q10Function | Q10 temperature multiplier | Built-in Model Components |
DataFrameStore, DayStore, DateStore, TimeStore, TableStore | indexed tabular inputs | Built-in Model Components |
Date, Dates | re-exported Dates names | Built-in Model Components |
ZonedDateTime, tz"..." | re-exported TimeZones names | Built-in Model Components |
Documented object index
The generated index below links docstrings included in the reference pages. Some exported helpers are described manually above because their implementation does not yet carry a standalone docstring.