Skip to content

Commit

Permalink
dev-notes: barebones list of file format needs for current capabiliti…
Browse files Browse the repository at this point in the history
…es of VFGEN.
  • Loading branch information
WarrenWeckesser committed Oct 4, 2024
1 parent 07d1da2 commit dcb3559
Showing 1 changed file with 41 additions and 0 deletions.
41 changes: 41 additions & 0 deletions dev-notes/file-format.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
VFGEN needs an alternative to the XML file format.

For the current capabilities of VFGEN, the essential information is

vector_field
name (id)
independent_variable (id)
description (text)

constant
name (id)
value (formula)
description (text)
latex (text)

parameter
name (id)
description (text)
default_value (formula)
latex (text)

expression
name (id)
formula (formula)
description (text)
latex (text)

state_variable
name (id)
derivative (formula)
description (text)
period_from (formula)
period_to (formula)
default_ic (formula)
default_history (formula)
latex (text)

function
name (id)
formula (formula)
description (text)

0 comments on commit dcb3559

Please sign in to comment.