Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

When visualising restrictions, annotate the edges with the restriction type by default #339

Merged
merged 3 commits into from
Jan 5, 2022

Conversation

jesper-friis
Copy link
Collaborator

Used to produce the graphs for the updated README for EMMO 1.0.0-beta3:
https://github.com/emmo-repo/EMMO/tree/updated-readme-and-figures

Description:

Type of change:

  • Bug fix.
  • New feature.
  • Documentation update.

Checklist:

This checklist can be used as a help for the reviewer.

  • Is the code easy to read and understand?
  • Are comments for humans to read, not computers to disregard?
  • Does a new feature has an accompanying new test (in the CI or unit testing schemes)?
  • Has the documentation been updated as necessary?
  • Does this close the issue?
  • Is the change limited to the issue?
  • Are errors handled for all outcomes?
  • Does the new feature provide new restrictions on dependencies, and if so is this documented?

Comments:

…n type

by default.

Used to produce the graphs for the updated README for EMMO 1.0.0-beta3:
https://github.com/emmo-repo/EMMO/tree/updated-readme-and-figures
@jesper-friis
Copy link
Collaborator Author

The CI workflow fails with an internal error. Running it locally works fine:

$ mkdocs build --strict 
INFO     -  Cleaning site directory
INFO     -  Building documentation to directory:
            /home/friisj/prosjekter/EMMC/EMMO-python/site
INFO     -  Documentation built in 2.79 seconds
$ mkdocs --version
mkdocs, version 1.2.3 from /home/friisj/.local/lib/python3.9/site-packages/mkdocs (Python 3.9)

Looks more like a bug in mkdocs than in EMMOntoPy...

Copy link
Collaborator

@CasperWA CasperWA left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems fine to me - although some of it goes a bit beyond my knowledge :)
"Squash and merge" at will for my sake.

Copy link
Collaborator

@francescalb francescalb left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

image

As of now hasConstituent, hasProperPArt and has SpatialEssentialPArt are the same. As suggest that at least has Consituent and hasSpatialPart get their own colors. Furthermore, I also think it makes sense to add the label if the revert to the default color.

@jesper-friis
Copy link
Collaborator Author

As of now hasConstituent, hasProperPArt and has SpatialEssentialPArt are the same. As suggest that at least has Consituent and hasSpatialPart get their own colors. Furthermore, I also think it makes sense to add the label if the revert to the default color.

I agree that it would be a good idea to review the default colours and styles. But I think EMMO has too many relations to give all of them a unique default colour/style combination. One possibility could be to make mereological, topological and semiotical relations solid, dashed and dotted respectively. For colours we could either

  • leave it to the user to define them for each plot
  • define explicit colours for some high-level/important relations within each category
  • define a colour cycle and more or less randomly assign them to the relations present in the graph (pros: all relations will get a unique colour by default; cons: the same relation may get different colours in two different graphs)

I think this should be a new issue.

@francescalb
Copy link
Collaborator

As of now hasConstituent, hasProperPArt and has SpatialEssentialPArt are the same. As suggest that at least has Consituent and hasSpatialPart get their own colors. Furthermore, I also think it makes sense to add the label if the revert to the default color.

I agree that it would be a good idea to review the default colours and styles. But I think EMMO has too many relations to give all of them a unique default colour/style combination. One possibility could be to make mereological, topological and semiotical relations solid, dashed and dotted respectively. For colours we could either

  • leave it to the user to define them for each plot
  • define explicit colours for some high-level/important relations within each category
  • define a colour cycle and more or less randomly assign them to the relations present in the graph (pros: all relations will get a unique colour by default; cons: the same relation may get different colours in two different graphs)

I think this should be a new issue.

Ok, then I think this PR can be approved.

@francescalb francescalb self-requested a review January 4, 2022 07:44
@jesper-friis jesper-friis merged commit 154dca8 into master Jan 5, 2022
@jesper-friis jesper-friis deleted the visualise-restriction-type branch January 5, 2022 11:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants