Version: dev

All stable operations

Every stable (name, kind) of the API surface, A–Z.

OperationKindTopicJuliaTypeScriptPythonRustGo
add_continuous_eventfunctionEditingyesyesyes—yes
add_couplingfunctionEditingyesyesyesyesyes
add_discrete_eventfunctionEditingyesyesyes—yes
add_equationfunctionEditingyesyesyesyesyes
add_reactionfunctionEditingyesyesyesyesyes
add_speciesfunctionEditingyesyesyesyesyes
add_variablefunctionEditingyesyesyesyesyes
affect_equationtypeDocument typesyes—yesyesyes
algebraic_unknownsfunctionVariable classificationyesyesyesyesyes
apply_dae_contractfunctionVariable classification———yesyes
apply_scope_injectionsfunctionLoad-time lowering and templates—yes—yes—
apply_unit_conversionfunctionUnitsyes—yes——
area_tolerance_okfunctionRelational keys and geometry——yesyes—
assertion_resulttypeSimulationyes——yes—
brownian_parametersfunctionVariable classificationyesyesyesyesyes
build_reference_graphfunctionGraphsyesyesyesyesyes
build_unit_envfunctionUnits———yesyes
cadencetypeRuntime I/O———yesyes
cadence_errorerrorRuntime I/O——yesyesyes
callback_settypeSimulation——yesyes—
callbacksfunctionSimulationyes—yesyes—
can_migratefunctionVersions and migrationyesyesyesyesyes
canonical_index_set_jsonfunctionDocument I/O——yesyes—
canonical_jsonfunctionDocument I/Oyesyes—yesyes
canonicalizefunctionDocument I/Oyesyes—yesyes
canonicalize_errorerrorDocument I/Oyesyes—yes—
circular_reference_errorerrorLoad-time lowering and templates—yesyes——
closed_function_errorerrorExpressionsyesyes—yesyes
closed_function_namesfunctionExpressionsyesyes—yesyes
compilertypeSimulation——yesyes—
compiler_reporttypeSimulationyes—yesyes—
component_existsfunctionEditing—yesyesyes—
component_graphfunctionGraphsyesyesyesyes—
component_graphtypeGraphs—yes—yesyes
component_nodetypeGraphsyesyesyesyesyes
composefunctionEditingyesyes—yesyes
conflicting_derivative_errorerrorFlattenyesyesyes—yes
constant_parametersfunctionVariable classificationyesyesyesyesyes
containsfunctionExpressions—yesyesyesyes
continuous_eventtypeDocument typesyes—yesyesyes
contributiontypeOtheryesyesyesyesyes
convert_unitsfunctionUnits—yesyesyes—
coordinatetypeDocument types———yesyes
couple_multiplicative_no_tendency_errorerrorFlatten—yesyes—yes
coupling_coupletypeDocument typesyes———yes
coupling_edgetypeGraphsyesyesyesyesyes
coupling_entrytypeDocument typesyes—yesyesyes
coupling_importtypeDocument typesyes—yes—yes
coupling_import_optionstypeDocument types—yes—yesyes
coupling_roletypeDocument types———yesyes
cyclic_promotion_errorerrorFlattenyes—yes——
dae_infotypeVariable classification———yesyes
data_sourcetypeDocument typesyes—yesyesyes
data_source_bindingtypeDocument typesyes—yesyesyes
data_source_determinismtypeDocument typesyes—yesyesyes
data_source_kindtypeDocument types——yesyes—
data_source_locationtypeDocument typesyes—yesyesyes
data_source_temporaltypeDocument typesyes—yesyesyes
declared_system_kindfunctionVariable classificationyesyesyes—yes
decompositiontypeOtheryes——yes—
default_abstolconstantSimulation—yes—yes—
default_forcing_setfunctionOtheryes—yes——
default_reltolconstantSimulation—yes—yes—
dependency_edgetypeGraphsyesyesyesyesyes
derive_odesfunctionReactionsyesyesyesyesyes
derive_output_griddingfunctionRuntime I/Oyes——yes—
derive_output_metafunctionRuntime I/Oyes——yes—
derive_output_planfunctionRuntime I/Oyes——yes—
desugar_pushdownfunctionLoad-time lowering and templates——yesyes—
dimensiontypeDocument types———yesyes
dimension_promotion_errorerrorFlattenyesyesyes—yes
discrete_eventtypeDocument typesyes—yesyesyes
discrete_event_triggertypeDocument typesyes—yesyesyes
discrete_parametersfunctionVariable classificationyesyesyesyesyes
distinctfunctionRelational keys and geometry——yesyes—
distributiontypeDocument typesyes—yesyesyes
domaintypeDocument typesyes—yesyesyes
domain_extent_mismatch_errorerrorFlattenyes—yes——
domain_unit_mismatch_errorerrorFlattenyesyesyes——
earth_sci_ast_errorerrorErrorsyes—yes——
edge_kindtypeGraphs—yesyesyesyes
edit_errorerrorEditingyes——yesyes
effective_system_kindfunctionVariable classificationyesyesyes—yes
emit_documentfunctionDocument I/O—yesyes——
emit_esm_stringfunctionDocument I/O—yesyes——
ensemble_problemtypeSimulation——yesyes—
entity_not_found_errorerrorEditing—yes——yes
enum_lowering_errorerrorLoad-time lowering and templatesyesyesyesyesyes
ephemeral_injected_filefunctionLoad-time lowering and templates—yes—yes—
equationtypeDocument typesyes—yesyesyes
error_code_namesfunctionErrorsyes——yes—
error_codesconstantErrorsyesyesyesyes—
esm_filetypeDocument typesyes—yesyesyes
esm_problemfunctionSimulationyes—yesyes—
esm_problemtypeSimulationyes—yesyes—
evaluatefunctionExpressions——yesyesyes
evaluate_cellwisefunctionSimulationyes——yes—
evaluate_closed_functionfunctionExpressionsyes——yesyes
exact_scaletypeUnits———yesyes
expandfunctionExpressions——yes—yes
expand_coupling_importsfunctionLoad-time lowering and templatesyesyesyesyes—
expand_documentfunctionLoad-time lowering and templates—yesyes——
exprtypeExpressions——yesyes—
expr_nodetypeExpressions——yes—yes
expression_graphfunctionGraphsyesyesyesyes—
expression_graphtypeGraphs———yesyes
expression_graph_optionstypeGraphs———yesyes
expression_parse_errorerrorExpressionsyesyesyesyesyes
expression_template_errorerrorLoad-time lowering and templatesyesyesyes—yes
extractfunctionEditingyesyesyes—yes
field_reducefunctionSimulationyes——yes—
flattenfunctionFlattenyesyesyesyesyes
flatten_errorerrorFlatten—yesyesyes—
flatten_metadatatypeFlattenyesyesyesyesyes
flatten_template_registriesfunctionFlatten—yesyes——
flatten_with_optionsfunctionFlatten———yesyes
flattened_equationtypeFlatten—yesyes—yes
flattened_systemtypeFlattenyesyesyesyesyes
flattened_variabletypeFlatten—yesyes—yes
float_key_errorerrorRelational keys and geometry——yesyes—
forcing_setfunctionOtheryes—yes——
forcing_settypeOtheryes——yes—
forcing_slottypeOtheryes——yes—
format_canonical_floatfunctionDocument I/Oyesyes—yes—
free_parametersfunctionVariable classification—yesyesyes—
free_variablesfunctionExpressionsyesyesyesyesyes
function_tabletypeDocument typesyes—yes—yes
function_table_axistypeDocument typesyes—yes—yes
functional_updatetypeDocument typesyes—yesyesyes
geometry_errorerrorRelational keys and geometry——yesyes—
get_component_typefunctionEditing—yes—yes—
graphtypeGraphsyesyesyesyesyes
graph_edgetypeGraphs——yes—yes
grid_plantypeRuntime I/Oyes——yes—
group_aggregatefunctionRelational keys and geometry——yesyes—
group_gridding_by_gridfunctionRuntime I/Oyes——yes—
halofunctionOtheryes—yes——
initfunctionSimulation——yesyes—
inline_test_optionstypeSimulationyes——yes—
integratortypeSimulation——yesyes—
intersect_polygonfunctionRelational keys and geometry——yesyes—
is_coupling_library_docfunctionLoad-time lowering and templates—yesyesyes—
is_ode_statefunctionVariable classificationyesyesyesyesyes
is_template_library_docfunctionLoad-time lowering and templates—yes—yes—
lanesfunctionOtheryes—yes——
library_versionconstantVersions and migrationyesyesyesyesyes
load_documentfunctionDocument I/Oyesyesyesyesyes
load_optionstypeDocument I/O—yes—yes—
load_pathfunctionDocument I/Oyesyesyesyesyes
load_stringfunctionDocument I/Oyesyesyesyesyes
loader_fieldtypeDocument I/O—yesyesyesyes
lower_enumsfunctionLoad-time lowering and templatesyesyesyesyesyes
lower_enums_mutfunctionLoad-time lowering and templates——yesyesyes
lower_expression_templatesfunctionLoad-time lowering and templatesyesyesyes—yes
lower_reactions_to_equationsfunctionReactionsyes——yes—
map_variablefunctionEditingyesyes——yes
materialize_value_inventionfunctionLoad-time lowering and templates——yesyes—
max_template_expansion_depthconstantLoad-time lowering and templates—yesyes—yes
mergefunctionEditing—yesyes—yes
metadatatypeDocument typesyes—yesyesyes
migratefunctionVersions and migrationyesyesyesyesyes
migration_errorerrorVersions and migrationyesyesyesyesyes
modeltypeDocument typesyes—yesyesyes
model_variabletypeDocument typesyes—yesyesyes
observed_definitionfunctionVariable classificationyes———yes
observed_definitionsfunctionVariable classificationyesyesyesyes—
observed_fieldfunctionSimulationyes—yesyes—
observed_unknownsfunctionVariable classificationyesyesyesyesyes
ode_statesfunctionVariable classificationyesyesyesyesyes
operatortypeDocument types——yesyes—
operator_compose_ambiguous_bare_name_errorerrorFlattenyesyesyes—yes
operator_compose_no_merge_errorerrorFlattenyesyesyes—yes
operator_compose_require_match_errorerrorFlattenyesyesyes—yes
output_errorerrorRuntime I/Oyes——yes—
output_metatypeRuntime I/Oyes——yes—
output_plantypeRuntime I/Oyes——yes—
param_slottypeOtheryes——yes—
parametertypeDocument typesyes—yes—yes
parameter_sweeptypeDocument types———yesyes
parameter_updatetypeDocument typesyes—yesyesyes
parametersfunctionVariable classificationyesyes———
parse_equationfunctionExpressionsyesyesyesyesyes
parse_errorerrorErrorsyesyes———
parse_expressionfunctionExpressionsyesyesyesyesyes
parse_unitfunctionUnits—yes—yesyes
parse_unit_conversionfunctionUnitsyes—yes——
partitiontypeRuntime I/O——yesyes—
plan_dimension_coordinatesfunctionRuntime I/Oyes——yes—
plottypeDocument types———yesyes
plot_axistypeDocument types———yesyes
plot_seriestypeDocument types———yesyes
plot_valuetypeDocument types———yesyes
polygon_areafunctionRelational keys and geometry——yesyes—
product_matrixfunctionReactions—yesyes——
rankfunctionRelational keys and geometry——yesyes—
rankingtypeRelational keys and geometry——yesyes—
reactiontypeDocument typesyes—yesyesyes
reaction_systemtypeDocument typesyes—yesyesyes
referencetypeDocument typesyes—yes—yes
reference_edgetypeGraphsyesyesyesyesyes
reference_graphtypeGraphsyesyesyesyesyes
reference_resolution_errorerrorGraphsyesyesyesyesyes
reference_vertextypeGraphsyesyesyesyesyes
reject_expression_templates_pre_v04functionVersions and migrationyesyesyes—yes
reject_solver_external_pre_v13functionOtheryesyesyesyesyes
reject_solver_pre_v11functionVersions and migrationyesyesyesyesyes
reject_solver_time_span_pre_v13functionOtheryesyesyesyesyes
reject_template_imports_pre_v08functionVersions and migrationyesyesyesyesyes
remakefunctionSimulation——yesyes—
remove_couplingfunctionEditingyesyesyesyesyes
remove_equationfunctionEditingyesyesyesyes—
remove_eventfunctionEditingyesyesyes—yes
remove_reactionfunctionEditingyesyesyesyesyes
remove_speciesfunctionEditingyesyesyesyesyes
remove_variablefunctionEditingyesyesyesyesyes
rename_variablefunctionEditingyesyesyes—yes
resolve_referencesfunctionGraphsyesyesyesyesyes
resolve_subsystem_refsfunctionLoad-time lowering and templatesyesyesyesyesyes
resolve_template_machineryfunctionLoad-time lowering and templatesyesyesyesyes—
resolve_time_spanfunctionOtheryesyesyesyesyes
resolve_tolerancesfunctionSimulationyesyesyesyes—
restrictfunctionOtheryes—yes——
return_codetypeSimulation——yesyes—
rhs_programfunctionOtheryes—yesyes—
run_inline_testsfunctionSimulationyes——yes—
sampled_parametersfunctionVariable classificationyesyesyesyesyes
schema_errorerrorValidation———yesyes
schema_errortypeValidationyesyes———
schema_validation_errorerrorValidationyesyesyes——
schema_versionconstantVersions and migrationyesyesyesyesyes
selectfunctionOtheryes—yes——
simplifyfunctionExpressionsyesyesyesyesyes
simulate_errorerrorSimulationyes——yes—
skolemfunctionRelational keys and geometry——yesyes—
skolem_edgefunctionRelational keys and geometry——yesyes—
slice_out_of_domain_errorerrorFlattenyes—yes——
solutiontypeSimulation——yesyes—
solvefunctionSimulation——yesyes—
solvertypeDocument typesyes—yesyesyes
solver_external_locationfunctionOtheryesyesyesyesyes
solver_time_spantypeOtheryes—yesyesyes
speciestypeDocument typesyes—yesyesyes
state_blocktypeOtheryes——yes—
stepfunctionSimulation——yesyes—
stoichiometric_matrixfunctionReactionsyesyesyesyesyes
structural_errorerrorValidation———yesyes
substitutefunctionExpressionsyesyesyesyesyes
substitute_in_equationsfunctionExpressionsyesyes——yes
substitute_in_modelfunctionExpressions—yesyesyesyes
substitute_in_model_with_contextfunctionExpressions———yesyes
substitute_in_reaction_systemfunctionExpressions—yesyesyesyes
substitute_in_reaction_system_with_contextfunctionExpressions———yesyes
substitute_with_contextfunctionExpressions———yesyes
substrate_matrixfunctionReactions—yesyes——
subsystem_ref_errorerrorLoad-time lowering and templatesyes—yes——
supported_migration_targetsfunctionVersions and migrationyesyesyesyesyes
sweep_dimensiontypeDocument types———yesyes
sweep_rangetypeDocument types———yesyes
system_kindfunctionVariable classificationyesyesyesyesyes
system_kindtypeVariable classification—yes—yes—
temporal_domaintypeDocument types——yes—yes
term_origintypeOtheryesyesyesyesyes
time_pointtypeOther———yesyes
time_spantypeDocument types———yesyes
to_asciifunctionDisplayyesyesyesyesyes
to_dotfunctionGraphsyesyesyesyesyes
to_jsonfunctionDocument I/Oyesyesyesyesyes
to_json_compactfunctionDocument I/Oyesyesyesyesyes
to_json_graphfunctionGraphsyesyesyesyesyes
to_julia_codefunctionDisplayyes—yes——
to_latexfunctionDisplayyesyesyesyesyes
to_mermaidfunctionGraphsyesyesyesyesyes
to_unicodefunctionDisplayyesyesyesyesyes
tolerancetypeDocument types———yesyes
unittypeUnits———yesyes
unit_conversion_errorerrorUnitsyesyesyes——
unit_findingtypeUnitsyes—yesyes—
unit_finding_analysisconstantUnits——yesyesyes
unit_finding_dimensional_mismatchconstantUnits——yesyesyes
unit_finding_dimensionless_literalconstantOtheryes—yesyesyes
unit_finding_unparseableconstantUnits——yesyesyes
unit_warningtypeUnitsyesyesyesyesyes
unknownsfunctionVariable classificationyesyesyes——
unmapped_domain_errorerrorFlattenyes—yes——
unsupported_mapping_errorerrorFlattenyes—yes——
validatefunctionValidationyesyesyesyesyes
validate_equation_dimensionsfunctionUnitsyes——yesyes
validate_pathfunctionValidationyes—yes——
validate_schemafunctionValidationyesyes———
validate_structuralfunctionValidationyes———yes
validate_textfunctionValidationyesyesyesyesyes
validate_unitsfunctionUnits—yesyes——
validation_errortypeValidation—yesyes——
validation_resulttypeValidationyesyesyesyesyes
value_invention_errorerrorLoad-time lowering and templates——yesyes—
value_invention_resulttypeLoad-time lowering and templates——yesyes—
var_griddingtypeRuntime I/Oyes——yes—
var_plantypeRuntime I/Oyes——yes—
variable_in_use_errorerrorEditing—yes——yes
variable_kindtypeVariable classification—yes—yes—
variable_nodetypeGraphsyesyesyesyesyes
vertex_kindtypeGraphs—yesyesyesyes
write_pathfunctionDocument I/Oyesyesyesyesyes