galaxyproject / galaxy

Data intensive science for everyone.
https://galaxyproject.org
Other
1.4k stars 1k forks source link

Galaxy Model UML #10338

Open innovate-invent opened 4 years ago

innovate-invent commented 4 years ago

It would be very helpful to automatically generate a UML diagram of Galaxies internal data model.

Some options to do this were explored here: https://github.com/ODM2/ODM2/issues/55

dannon commented 4 years ago

I actually have a script that does this; we used it years ago but it just didn't seem useful enough to keep updated. Neat to look at, though. I'll see if I can dig it up.

dannon commented 4 years ago

I found my script, but it doesn't work with the current version of sqlalchemy out of the box; I'll try to update it. Meanwhile, I remembered there was a training module on this that included a diagram manually generated with schemaspy: https://galaxyproject.github.io/training-material/topics/admin/images/galaxy_schema.png

innovate-invent commented 4 years ago

Is it possible to generate a svg with hyperlinks? Can you add the diagram to a "Internal Model" page here: https://docs.galaxyproject.org/en/latest/dev/index.html It would be nice to get a write-up started.

The image will be quite large, if possible it would be good to generate sub-diagrams based on subject. For example: all StoredWorkflow related objects, or Job execution related objects.