Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Refactor docs with @mtkmodel #2286

Merged
merged 7 commits into from
Oct 8, 2023
Merged

Refactor docs with @mtkmodel #2286

merged 7 commits into from
Oct 8, 2023

Conversation

ven-k
Copy link
Member

@ven-k ven-k commented Sep 27, 2023 •
edited
Loading

  • Refactors "Getting Started" page to use @mtkmodel and adds a note on using complete
  • Adds "Components" and "Connectors" section to MTKModel-Connector docs-page.
  • And elaborates what Model.structure is.
  • Refactors following tutorials with @mtkmodel
    • Acausal components
    • Structural identifiability
  • Adds connect section in Variable metadata
  • Updates ContextualVariables.md with get_unit and VariableUnit
  • Fixes u0 in Optimization tutorial

@ChrisRackauckas
Copy link
Member

What's left to merge?

@ArnoStrouwen
Copy link
Member

Could you retrigger CI @ChrisRackauckas?
I can at least resolve locally now.

@ChrisRackauckas
Copy link
Member

Needs to be resolved to trigger.

ArnoStrouwen
ArnoStrouwen suggested changes Oct 2, 2023
View reviewed changes
Copy link
Member

@ArnoStrouwen ArnoStrouwen left a comment

Choose a reason for hiding this comment

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

Fix for the SI tutorial.

docs/src/tutorials/parameter_identifiability.md Outdated
k5; k6; k7; k8; k9; k10
end
begin
D = Differential(t)
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
D = Differential(t)
@variables t
D = Differential(t)

Copy link
Member Author

Choose a reason for hiding this comment

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

Will resolve the conflicts and commit this in.

docs/src/tutorials/parameter_identifiability.md Outdated
@@ -66,8 +72,7 @@ Let's try to check specific parameters and their combinations

```@example SI
to_check = [k5, k7, k10 / k9, k5 + k6]
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
to_check = [k5, k7, k10 / k9, k5 + k6]
@unpack k5, k6, k7, k9, k10 = de
to_check = [k5, k7, k10 / k9, k5 + k6]

@ven-k
Copy link
Member Author

ven-k commented Oct 2, 2023

What's left to merge?

I'm refactoring the "Getting started" based on Friday's discussion. I'm planning to make a copy of it with @mtkmodel and rename the current "Getting started" as "Introduction to non-DSL based ModelingToolkit" (with maybe a little bit of minor cuts).

@ArnoStrouwen
Copy link
Member

I think the @connector macro needs a similar thorough explanation as the @mtkmodel macro is getting
Specifically, where Flow comes from.

Having docstrigns for both would also be a plus.

@ven-k ven-k force-pushed the vkb/mtkmodel-examples branch 2 times, most recently from e76e7dc to 5ccf94c Compare October 4, 2023 13:07
@ven-k ven-k changed the title Refactor tutorials with @mtkmodel Refactor docs with @mtkmodel Oct 4, 2023
@ven-k ven-k force-pushed the vkb/mtkmodel-examples branch from 5ccf94c to fa153f0 Compare October 4, 2023 13:29
@ven-k
Copy link
Member Author

ven-k commented Oct 4, 2023

Note that these have changed since the previous push:

  • Refactors "Getting Started" page to use @mtkmodel and adds a note on using complete
  • Adds "Components" and "Connectors" section to MTKModel-Connector docs-page.
  • And elaborates what Model.structure is.
  • Adds connect section in Variable metadata
  • Updates ContextualVariables.md with get_unit and VariableUnit

@ven-k ven-k marked this pull request as ready for review October 4, 2023 13:29
@YingboMa
Copy link
Member

YingboMa commented Oct 4, 2023

What does it take to fix the Documentation CI?

@ven-k
Copy link
Member Author

ven-k commented Oct 5, 2023

@ChrisRackauckas
Copy link
Member

what's left to merge?

@ven-k
Copy link
Member Author

ven-k commented Oct 8, 2023

I'll retrigger docs build.

@ven-k ven-k force-pushed the vkb/mtkmodel-examples branch from fa153f0 to 94a4f06 Compare October 8, 2023 04:29
@ven-k
docs: add connect section to Variable metadata
2ef4752 
- while here, update the description on setting unit metadata in   Contextual-Variables
@ven-k ven-k force-pushed the vkb/mtkmodel-examples branch from 94a4f06 to 2ef4752 Compare October 8, 2023 05:29
@ChrisRackauckas
Copy link
Member

Let's merge and follow up with more changes.

@ChrisRackauckas ChrisRackauckas merged commit 3034c9f into SciML:master Oct 8, 2023
3 of 4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ArnoStrouwen ArnoStrouwen ArnoStrouwen requested changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@ven-k @ChrisRackauckas @ArnoStrouwen @YingboMa