-
Notifications
You must be signed in to change notification settings - Fork 4
Open
Labels
consistencydocumentationImprovements or additions to documentationImprovements or additions to documentationquestionFurther information is requestedFurther information is requested
Description
After giving it some thought, here's what I would suggest for sgMAM:
- I would rename
sgmam
tosimple_geometric_min_action_method
following the style conventions of JuliaDynamics (alternative: we drop the_method
in all functions we have defined) - I would rename
SgmamSystem(H_x, H_p)
toHamiltonsTerms(H_x, H_p)
or similar (can't think of a great name but it's not really Hamilton's equations and not the Hamiltonian either) - It makes sense to write
sgmam
as a function ofSgmamSystem
, which I would interpret as a mid-level function. It would be great to have a functionHamiltonsTerms(CoupledSDEs)
that extracts the termsH_x
andH_p
from a suitableCoupledSDEs
system, and then one could write a high-level function:
simple_geometric_min_action_method(CoupledSDEs) = simple_geometric_min_action_method(HamiltonsTerms(CoupledSDEs))
I suppose it would be some work to write the function HamiltonsTerms(CoupledSDEs)
generally, so maybe we can leave that as an open issue and for now just
- rename the type/function
- explain in the docs that
HamiltonsTerms
is related to the underlying SDE via

Happy to hear your thoughts @oameye :)
Metadata
Metadata
Assignees
Labels
consistencydocumentationImprovements or additions to documentationImprovements or additions to documentationquestionFurther information is requestedFurther information is requested