Add release notes for v4.1.0

[Harisankar-Allimangalath]

This has been added for the library officers to suggest and add the changes to the Release notes.

[Harisankar-Allimangalath]

@beutlich Thankyou for clarifying the mistake.

so from my understanding we should be adding the new content here

some information is already there , I shall add the remaining information which is mentioned here https://github.com/modelica/ModelicaStandardLibrary/pull/4300 .

[tobolar]

@Harisankar-Allimangalath

from my understanding we should be adding the new content here

Yes, this is how the release notes appear in a tool. What @beutlich means is there is a corresponding Modelica file Modelica/UsersGuide/ReleaseNotes.mo where the release notes shall in fact be changed.

[beutlich]

@Harisankar-Allimangalath Due to #4355 there are merge conflicts now. Can you please resolve them. Thanks.

[Esther-Devakirubai]

@casella can you please add description for Modelica.Fluid.Vessels.OpenTank. Added a placeholder for it in the non-backwards compatible list.

[beutlich]

@Esther-Devakirubai ❗ I resolved the merge conflict and squashed all changes.

[coderabbitai[bot]]

Walkthrough

This update introduces comprehensive release notes for Modelica Standard Library version 4.1.0, providing both an HTML and a Modelica (.mo) version. The release notes document major changes, including new components, renaming and restructuring of sublibraries, and the introduction of new libraries. They detail backward and non-backward compatible changes, critical bug fixes, and list tested external packages for compatibility. The documentation also highlights the resolution of hundreds of issues and pull requests, and specifies obsolete components and their replacements.

Changes

File(s)	Change Summary
Modelica/Resources/ReleaseNotes/Modelica.UsersGuide.ReleaseNotes.Version_4_1_0.html	Added a new HTML file containing detailed release notes for Modelica version 4.1.0, covering major updates, compatibility notes, sublibrary renaming, new libraries and components, improvements, bug fixes, and a list of tested external packages.
Modelica/UsersGuide/ReleaseNotes.mo	Expanded and restructured the Modelica release notes with explicit lists of new components, backward and non-backward compatible changes, critical error fixes, obsolete models, and updated references. Includes detailed enumeration of new entities and modifications to existing ones.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant ReleaseNotes (HTML/.mo)
    participant Modelica Library

    User->>ReleaseNotes (HTML/.mo): Access release notes for v4.1.0
    ReleaseNotes (HTML/.mo)->>User: Display new features, changes, compatibility info
    User->>Modelica Library: Update or migrate models as per notes
    Modelica Library-->>User: Provide updated components and libraries

Suggested labels

L: Resources

Suggested reviewers

• Esther-Devakirubai

Poem

Hop, hop! A new release is here,
With notes so thorough, changes clear.
New blocks and sources, libraries in tow,
Old names retired, new ones on show.
Bugs squashed flat, improvements abound—
In Modelica 4.1.0, progress is found!
🐇✨

---

📜 Recent review details

Configuration used: CodeRabbit UI Review profile: CHILL Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between d8364f921221adf9d286a7cc8005f5ee146296c2 and 7989a88ce328933b84ab802b3fe7517d55f0f8f4.

📒 Files selected for processing (1)

• Modelica/UsersGuide/ReleaseNotes.mo (3 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (2)

• GitHub Check: external_c_checks_cmake_windows-msvc
• GitHub Check: external_c_checks_cmake_windows-cygwin

🔇 Additional comments (1)

Modelica/UsersGuide/ReleaseNotes.mo (1)

133-584: Excellent release notes documentation for version 4.1.0.

The release notes provide comprehensive information about:

• Backward compatibility with version 4.0.0
• Number of resolved issues (554, including 387 pull requests)
• 44 external libraries tested with version 4.1.0
• New components added to existing libraries
• Backward compatible improvements
• Non-backward compatible changes
• Critical errors fixed
• Obsolete models

This thorough documentation helps users understand what has changed in this version and how it might impact their models. The format is consistent with previous release notes.

---

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.