Skip to content

Timelines documentation - #415

Merged
IrisvdWerf merged 39 commits into
multiscale:developfrom
IrisvdWerf:timeline-docs
Oct 1, 2026
Merged

IrisvdWerf merged 39 commits into
multiscale:developfrom
IrisvdWerf:timeline-docs

Conversation

@IrisvdWerf

Copy link
Copy Markdown
Collaborator

No description provided.

@IrisvdWerf
IrisvdWerf marked this pull request as ready for review September 11, 2026 12:42
@IrisvdWerf

IrisvdWerf commented Sep 29, 2026 •

Copy link
Copy Markdown
Collaborator Author

Include the example Lourens suggested in multiscale/ymmsl-python#66:

"I think it would be good to have an example of an init component dispatching to a micro with one or two filters, because that's the first use case for BRIDGE."

@LourensVeen LourensVeen left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is super nice! Clear, concise, and hopefully not too computer sciency and abstract, which is a common complaint about anything related to MUSCLE3 and MMSF. We'll see what the users think, but I don't see a way of doing it better.

I added a few comments that you may want to look at, I'll leave it to you to decide since your background is closer to that of the users than mine.

Comment thread docs/source/coupling.rst
Comment thread docs/source/coupling.rst
In that case you can declare the two timelines as matching timelines. Each
component still has its own timeline, but conduits between ports on matching
timelines are then allowed. See the yMMSL documentation on
:external+ymmsl:ref:`matching_timelines <Matching timelines>` for how to

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These external references don't seem to work, but maybe that's just because they're not pointing at the right version?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, yes, stable, so that should start working after the release. Although maybe we can change it to develop temporarily to test?

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I’ll change it to develop. Would you like me to just check it, or should I leave it as is and change it back after we’ve merged the Timeline Bridge documentation?

Comment thread docs/source/coupling.rst
@IrisvdWerf
IrisvdWerf merged commit 34b2fd9 into multiscale:develop Oct 1, 2026
13 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants