multiscale / muscle3

The third major version of the MUltiScale Coupling Library and Environment
Apache License 2.0
25 stars 13 forks source link

Document dynamic ports API #239

Open LourensVeen opened 1 year ago

LourensVeen commented 1 year ago

We have an API in libmuscle for making components with ports defined only in the yMMSL file. It's intended to be used to create generic mappers that can e.g. take any number of inputs and merge them into a list of items.

While the individual functions are documented in the API docs, there's no explanation of what they're for and how to use them. We now have users that want to use this functionality, so we should add some documentation on how to do it.