Skip to content

Create Tutorial.md based on 1.4 tutorial #3672

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
Open
wants to merge 30 commits into
base: master
Choose a base branch
from
Open

Create Tutorial.md based on 1.4 tutorial #3672

wants to merge 30 commits into from

Conversation

HansOlsson
Copy link
Collaborator

@HansOlsson HansOlsson commented Apr 14, 2025 •
edited
Loading

Manually converted from pdf-document.

I no longer consider it a draft.

Most issues below are handled, and the rest (and unknown issues) can be handled after merging as it is now better than the old document.

  • Figures are missing
  • Missing table of contents, I haven't yet checked how to link to headings
  • References to the specification are likely incorrect. I would propose to link to HTML-version of specification.modelica.org (ideally development version to master and "released tutorial" to "released version", but focus on master)
  • I would propose to remove the changes-list and contributors to 1.4; similarly as we did for the specification
  • Need to update contents so that it is correct (due to changes, and stuff that never made it)
    • Graphical 1.4 primitives should be replaced by Modelica 2/3 annotations.
    • In some cases I would propose to remove the details, e.g., graphics.
    • Conditional components (as it instead had some enable idea that never made it)
    • Used MSL should correspond to actual MSL
      • The electric pin used Voltage instead of ElectricPotential. (It is correct in MSL.)
      • SI-units, new sub-packages
    • More?
  • The mapping of packages to files is likely a mess, I propose to remove that as well.
  • Should be linked from ReadMe
  • The references are at least missing recent ones, and possibly just outdated. I don't know how to best handle that. Preliminarily I made it into a readable list, and stated that they are references for the original design.

Less important ones (can be done after merging):

  • Lots of code as just text (I corrected anything with * to avoid italics
  • Lots of new constructs are not described; might add or link to MCP-documents, papers etc. Delayed
    • for-expressions might be useful (similarly as using if-equations instead of if-expressions makes the code more readable).

From casella - see 3674

@HansOlsson
Create Tutorial.md
8d3e1da 
Manually converted from pfd-document.
@HansOlsson
Copy link
Collaborator Author

Here's a link to the document:

https://github.com/HansOlsson/ModelicaSpecification/blob/Tutorial/Tutorial.md

And the entire branch:

https://github.com/HansOlsson/ModelicaSpecification/tree/Tutorial

HansOlsson and others added 16 commits April 14, 2025 16:47
@HansOlsson
Update README.md
70004da 
Add link to tutorial
@HansOlsson
Update Tutorial.md
92da6a7 
Add contents
@HansOlsson
Update Tutorial.md
ad2bca8 
Add spaces
@HansOlsson
Update Tutorial.md
010cf8a 
Replace file mapping and MODELICAPATH by references.
- Basically the file mapping was too messy to quickly clean up for me. We could re-add it someone has the time.
- The MODELICAPATH information was outdated. We no longer recommend relying on an environment variable (since that creates a mess with multiple tool).
@HansOlsson
Update Tutorial.md
560777c 
Update to Modelica 2 graphical annotations.

Remove most of the graphical annotations, since those details it don't fit with a tutorial.
@HansOlsson
Update Tutorial.md
679ce8a 
Remove changes, and update references.
@HansOlsson
Update Tutorial.md
2d21f4b 
The enable-attribute does not exist, and they are now called "conditional components" not "conditional models".
Having a more detailed tutorial for state-machines would be good.
@HansOlsson
Update Tutorial.md
beca1da 
Be consistent with the Modelica standard library.
@HansOlsson
Update Tutorial.md
1358800 
Updated link-references, internally, to spec, and to MSL.
@HansOlsson
Update Tutorial.md
322e439 
Minor cleanup
@HansOlsson
Update Tutorial.md
e608fad 
Also propose if-equations, since if-expressions seems like a bad solution.
@HansOlsson
Update Tutorial.md
c4efcb2 
Introduce if-equations as a better alternative, and also update explanation to explain why.
@HansOlsson
Update Tutorial.md
bfe8ccf 
Use if-equation for pendulum as well.
@HansOlsson
Add files via upload
40c5e82 
Add figures from 1.4 rationale, and fig5 from 1.4 tutorial.
@HansOlsson
MovedFiles
2158960
@HansOlsson
Update Tutorial.md
a39449a 
Add images
@HansOlsson
Copy link
Collaborator Author

More work is needed, but it should now be as good as the original document.
One possibility is to just add as is, and then start working on improving it.

For recent changes I would propose a paragraph and then a link to MCP and/or paper.

@HansOlsson HansOlsson marked this pull request as ready for review April 15, 2025 08:26
@HansOlsson
Update Tutorial.md
88ed71d 
Missed language setting
@HansOlsson
Update Tutorial.md
db3aae9 
Indicate that it isn't just 1.4.
@HansOlsson
Update Tutorial.md
816f054 
Use ElectricPotential instead of Voltage in the connectors.
@HansOlsson
Update Tutorial.md
15b0306 
Fix indentation
@HansOlsson
Update Tutorial.md
39a9832 
Modelica.SIunits -> Modelica.Units.SI and specific changes.
beutlich
beutlich reviewed Apr 15, 2025
View reviewed changes
@HansOlsson HansOlsson requested a review from GallLeo April 16, 2025 14:34
@HansOlsson
Update Tutorial.md
882a45f 
Convert to code.
Updated some bad code to current Modelica.
@HansOlsson
Update Tutorial.md
21d8419 
Referencing SCCS and old version systems isn't good.
And saying that the history information is _comparable_ to version control systems no longer seem relevant with good version control systems.
so just deleted.
@HansOlsson
Copy link
Collaborator Author

Will move the rest to another issue.

@HansOlsson HansOlsson mentioned this pull request Apr 22, 2025
Open
7 tasks
@HansOlsson
Update Tutorial.md
5e1fccb 
Sensible reference.
@HansOlsson HansOlsson mentioned this pull request Apr 23, 2025
Open
@HansOlsson HansOlsson added this to the 2025-May milestone May 7, 2025
@HansOlsson
Copy link
Collaborator Author

Add:

  • newer features are missing.
  • not covered features (link to MCP etc if possible)

@HansOlsson

HansOlsson added 3 commits May 9, 2025 08:47
@HansOlsson
Update Tutorial.md
01470a9 
Closes modelica#3674

Adds a list of new features, and notes that the tutorial is up-to-date, but doesn't explain newer features.
@HansOlsson
Update Tutorial.md
b3ef4f2 
Update
@HansOlsson
Update Tutorial.md
a8b5aee 
Minor text change, and
Replaced examples-link to first workshop by link to all proceedings.
@HansOlsson
Copy link
Collaborator Author

Now updated with a list of newer features; we can later refine it.
@casella do you think it is good enough now?

@HansOlsson
Update Tutorial.md
d5a7884 
Update homotopy with doi-link
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@beutlich beutlich beutlich left review comments

@GallLeo GallLeo Awaiting requested review from GallLeo

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
2025-May
Development

Successfully merging this pull request may close these issues.
2 participants
@HansOlsson @beutlich