Skip to content

Latest commit

 

History

History
65 lines (43 loc) · 4.9 KB

README.md

File metadata and controls

65 lines (43 loc) · 4.9 KB
Raw

Metroscope Modeling Library

Metroscope TSP License GitHub release (with filter)

📃 Content

The Metroscope Modeling Library contains modelica modules for industrial components such as pumps, turbines, heat exchangers, to build steady-state digital twins of industrial process. The associated documentation contains explanation of the library equations.

🏗️ Usage

  • When creating a Digital Twin you should only use official releases of Metroscope Modeling Library. Official releases can be downloaded from here.
  • In your model, you should add a line in annotation, containing the following : uses(MetroscopeModelingLibrary(version(="3.0.1")) in which you replace the version number ("3.0.1") by the one you use. That way you will get a warning if you use your model with a wrong version of the library.
  • If you need additionnal features, please ask for them using issues

📖 Documentation

Library documentation is available in this public Notion space. You can use comments in the documentation to ask questions about the library. Please do not include any proprieraty information. In order to comment the page, you need to create a Notion account.

🐛 Reporting a bug

GitHub issues by-label

  • Report your issues on issues page
  • Do not attach sensitive data to the GitHub issue you create
  • Provide following information
    • A clear and concise description of what the bug is
    • Steps to reproduce the bahavior
    • A clear and concise description of what you expected to happen.
    • Your configuration (OS, Modelica version, Metroscope Modeling Library version, modeling software & version)

👨‍💻 Contributions

GitHub issues by-label

Your contributions are very welcome. To contribute, you have to clone or fork the repository Metroscope Modeling Library: git clone git@github.com:Metroscope-dev/metroscope-modeling-library.git

To suggest changes, you have to:

  • checkout main branch: git checkout main
  • pull last changes: git pull
  • create a new branch: git checkout -b new-branch-name
  • commit your changes & push your code
  • create a pull request
    • Give a meaningfule title to your pull request (examples: Fix eta_is SteamTurbine or Add SteamTurbine)
    • Provide a comment explaining the changes
      • Aim of the changes
      • Description of the changes
      • If associated to an open GitHub issue, provide its url

For the sake of efficiency, create a draft pull request if you still have work to do before having your pull request reviewed (see Github documentation if needed).

Notify the MML team for a review of your PR.

ℹ️ Attribution notice

Licensed by Metroscope under the Modelica License 2 Copyright © 2023, Metroscope.

This Modelica package is free software and the use is completely at your own risk; it can be redistributed and/or modified under the terms of the Modelica License 2. For license conditions (including the disclaimer of warranty) see Modelica.UsersGuide.ModelicaLicense2 or visit http://www.modelica.org/licenses/ModelicaLicense2.

Metroscope Modeling Library is a Derivative Work of ThermoSysPro: