qudt / qudt-public-repo

QUDT -Quantities, Units, Dimensions and dataTypes - public repository
Other
116 stars 73 forks source link

QUDT and Datatypes schema documentation #290

Open VladimirAlexiev opened 3 years ago

VladimirAlexiev commented 3 years ago

http://www.qudt.org/doc/DOC_SCHEMA-QUDT.html is just a list of classes and props. Some terms have very brief descriptions and it's not easy to figure out what they do. Eg qudt:dimensionInverse is kind of disconnected from everything else...

Would it be possible to make some document that shows the layout and relations between the key classes? Those nice diagrams from TopBraid? I've seen such models in the past but not sure where, maybe they were in older QUDT versions?

steveraysteveray commented 3 years ago

Vladimir, Thanks for your attention to QUDT! I'll be trying to catch up with your various issues as time permits (we are an all-volunteer effort, and we all have day-jobs!). For now, have you checked the documentation on our web site homepage (qudt.org), as well as the Overview page (http://www.qudt.org/pages/QUDToverviewPage.html), the slide introduction (https://github.com/qudt/qudt-public-repo/blob/master/docs/2020-04-28%20Intro%20to%20QUDT.pdf) and finally, the wiki pages (https://github.com/qudt/qudt-public-repo/wiki/User-Guide-for-QUDT). The other comment I have is that there are a number of parts of QUDT that are legacies from the NASA days and are not really used. We haven't removed them, though, because we do intend to get back to them to bring them up to standards. Datatypes are one such example. Finally, you may not have realized it, but the page you mention, http://www.qudt.org/doc/DOC_SCHEMA-QUDT.html, is not just a list of the classes and props. Each link is an entry point to explore each class, prop and instance on our EDG server. We welcome suggestions for what would be most useful going forward.

jhodgesatmb commented 3 years ago

The architectural diagrams for QUDT are in: https://github.com/qudt/qudt-public-repo/wiki/User-Guide-for-QUDT

On Mon, Nov 23, 2020 at 9:39 AM steveraysteveray notifications@github.com wrote:

Vladimir, Thanks for your attention to QUDT! I'll be trying to catch up with your various issues as time permits (we are an all-volunteer effort, and we all have day-jobs!). For now, have you checked the documentation on our web site homepage (qudt.org), as well as the Overview page ( http://www.qudt.org/pages/QUDToverviewPage.html), the slide introduction ( https://github.com/qudt/qudt-public-repo/blob/master/docs/2020-04-28%20Intro%20to%20QUDT.pdf) and finally, the wiki pages ( https://github.com/qudt/qudt-public-repo/wiki/User-Guide-for-QUDT). The other comment I have is that there are a number of parts of QUDT that are legacies from the NASA days and are not really used. We haven't removed them, though, because we do intend to get back to them to bring them up to standards. Datatypes are one such example. Finally, you may not have realized it, but the page you mention, http://www.qudt.org/doc/DOC_SCHEMA-QUDT.html, is not just a list of the classes and props. Each link is an entry point to explore each class, prop and instance on our EDG server. We welcome suggestions for what would be most useful going forward.

— You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub https://github.com/qudt/qudt-public-repo/issues/290#issuecomment-732315618, or unsubscribe https://github.com/notifications/unsubscribe-auth/AATQRWLEKT3WLX7JVMYRA43SRKM3PANCNFSM4T7YXLXA .

-- Jack

VladimirAlexiev commented 3 years ago

Thanks! I'll check which classes and props are covered and hopefully submit some comments about the rest

steveraysteveray commented 3 years ago

And as with your earlier comments, please see my response here.