search

upb-lea / openmodelica-microgrid-gym

OpenModelica Microgrid Gym (OMG): An OpenAI Gym Environment for Microgrids
GNU General Public License v3.0
182 stars 37 forks source link

Publishing OpenModelica Library #61

Closed h-bode closed 3 years ago

h-bode commented 4 years ago

At https://www.modelica.org/libraries , several user defined libraries are published.

Contacted the website which requirements exist to get listed there, and if we should provide any additional information, pictures etc.

Until now, no response.

wallscheid commented 4 years ago

Still no response? If yes, please send a reminder.

h-bode commented 4 years ago

After getting no response from the general contact site, i wrote on wednesday directly to Michael Tiller, the "owner" of this library project, but he has not answered yet

h-bode commented 4 years ago

Henrik,

I presume you are referring to this Modelica library:

https://github.com/upb-lea/openmodelica-microgrid-gym/blob/master/fmu/grid.mo

There are a couple of things you'd need to do. The first is to publish the repository as a separate library. Other things that would be factors:

The repository would need to be structured in legal Modelica format of the repository (i.e., so that cloning the repository would give a directory with a legal Modelica library in it.  (see https://github.com/modelica-3rdparty/Buildings as a good example)
Include a README that contains clear information about license and authors
Ideally include git tags that correspond to the versions (again, see https://github.com/modelica-3rdparty/Buildings/tags).
Follow general Modelica style guidelines (i.e., those used for the standard library).  For example, all your restricted classes have lowercase names.  This is completely against the conventions used in the MSL.

I would suggest you make an iteration on those things and then come back to us and then we can make a decision about whether to include in the libraries page.

I hope that helps.

h-bode commented 4 years ago

Since this Mail was cc´ed to sjölund, he mentioned:

I would also suggest considering renaming the library since "grids" is so generic. Maybe Microgrid would be better (while you're anyway updating the names to fit Modelica conventions).

h-bode commented 4 years ago

Published a first version of the library on my private account.

A structure like this decreases the time for modelling DRASTICALLY, since not everything is stuffed to only one huge file.

https://github.com/h-bode/OpenModelica_Microgrids

I have send this to Michael Tiller and Sjölund for an additional feedback, if this library can be published on its own.

If everyone is fine with it (and if we have a final name for it) I would like to implement this form in the OMG toolbox as well.

I think that not much would change for the python code, only the name of the FMU will be different.

h-bode commented 4 years ago

According to sjoelund, we might advertise the toolbox itself at https://modelica.org/tools, too :)

h-bode commented 4 years ago

https://www.modelica.org/licenses/ModelicaLicense2

I think we could use this license for the library, seems to include everything we want, it is recommended by the the OpenModelica board, and other universities use it to publish their libraries, too.

h-bode commented 4 years ago

Published at the Modelica Libraries.

The OMG Toolbox itself will be published at: https://modelica.org/tools soon.

The description is taken automatically from description in the GitHub, which is the part below the about section. So we can update it without contacting the Modelica guys.