modelica / ModelicaStandardLibrary

Free (standard conforming) library to model mechanical (1D/3D), electrical (analog, digital, machines), magnetic, thermal, fluid, control systems and hierarchical state machines. Also numerical functions and functions for strings, files and streams are included.
https://doc.modelica.org
BSD 3-Clause "New" or "Revised" License
452 stars 165 forks source link

MSL v4.1.0-beta.1 feedback on asset structure #4308

Open beutlich opened 4 months ago

beutlich commented 4 months ago

This is the library structure of https://github.com/modelica/ModelicaStandardLibrary/releases/download/v4.0.0-beta.1/ModelicaStandardLibrary_v4.0.0-beta.1.zip

- Modelica 4.0.0/
- ModelicaReference 4.0.0/
- ModelicaServices 4.0.0/
- ModelicaTest/
- LICENSE
- README.md
- Complex.mo
- ModelicaTestConversion4.mo
- ModelicaTestOverdetermined.mo
- ObsoleteModelica4.mo

and this is how it looks in https://github.com/modelica/ModelicaStandardLibrary/releases/download/v4.1.0-beta.1/ModelicaStandardLibrary_v4.1.0-beta.1.zip

- ModelicaStandardLibrary-maint-4.1.0/
  |- Modelica/
  |- ModelicaReference/
  |- ModelicaServices/
  |- ModelicaTest/
  |- Complex.mo
  |- LICENSE
  |- ModelicaTestConversion4.mo
  |- ModelicaTestOverdetermined.mo
  |- ObsoleteModelica4.mo
  |- README.md

Two obvious issues here:

  1. The top-level directory ModelicaStandardLibrary-maint-4.1.0\ is not needed.
  2. The library directories miss the version suffix. Not sure if needed, but for now it is not consistent with what's documented at https://github.com/modelica/ModelicaStandardLibrary/wiki/Generating-a-new-MSL-release.
henrikt-ma commented 4 months ago

Two obvious issues here:

  1. The top-level directory ModelicaStandardLibrary-maint-4.1.0\ is not needed.
  2. The library directories miss the version suffix. Not sure if needed, but for now it is not consistent with what's documented at https://github.com/modelica/ModelicaStandardLibrary/wiki/Generating-a-new-MSL-release.

Consistency with what's documented is good, but perhaps it's the documentation that needs to be updated? To me, the new packaging looks better than the old one:

maltelenz commented 4 months ago

Not true: https://specification.modelica.org/master/annotations.html#mapping-of-versions-to-file-system

henrikt-ma commented 4 months ago

Not true: https://specification.modelica.org/master/annotations.html#mapping-of-versions-to-file-system

OK, so it wasn't that strange that it looked so familiar after all. Looks like it's time to update Directory Hierarchy Mapping then.

beutlich commented 4 months ago

Consistency with what's documented is good

Indeed, that's all what I am aiming for. We should at least stick with our own documentation and guidelines.