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

Color Voronoi Diagrams by Area #1012

Merged
merged 9 commits into from
Nov 21, 2022
Merged

Color Voronoi Diagrams by Area #1012

merged 9 commits into from
Nov 21, 2022

Conversation

tommy-waltmann
Copy link
Collaborator

@tommy-waltmann tommy-waltmann commented Sep 22, 2022

Description

This option adds the ability to color voronoi plots by the area of the Voronoi polytopes. It involves an API change from the option color_by_sides=True/False to color_by='sides'/''area'/None.

Motivation and Context

Resolves: #991

How Has This Been Tested?

I have tested this locally with a variety of arguments and input values. See screenshots section below.

Screenshots

With voro.plot()
voronoi_color_by_None

With voro.plot(color_by='sides')
voronoi_color_by_sides

With voro.plot(color_by='area')
voronoi_color_by_area

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds or improves functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Documentation improvement (updates to user guides, docstrings, or developer docs)

Checklist:

  • I have read the CONTRIBUTING document.
  • My code follows the code style of this project.
  • I have updated the documentation (if relevant).
  • I have added tests that cover my changes (if relevant).
  • All new and existing tests passed.
  • I have updated the credits.
  • I have updated the Changelog.

@tommy-waltmann tommy-waltmann requested a review from a team as a code owner September 22, 2022 18:53
@tommy-waltmann tommy-waltmann requested review from yeinlim and removed request for a team September 22, 2022 18:53
@tommy-waltmann
Copy link
Collaborator Author

tommy-waltmann commented Sep 22, 2022

NOTE: The changes in this PR will require an update to the examples repository.

@tommy-waltmann tommy-waltmann added this to the v3.0.0 milestone Sep 27, 2022
Copy link
Member

@b-butler b-butler left a comment

Choose a reason for hiding this comment

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

Left some comments to address.

doc/source/gettingstarted/migration.rst Outdated Show resolved Hide resolved
freud/plot.py Outdated Show resolved Hide resolved
freud/plot.py Show resolved Hide resolved
freud/plot.py Show resolved Hide resolved
freud/plot.py Show resolved Hide resolved
Copy link
Member

@b-butler b-butler left a comment

Choose a reason for hiding this comment

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

👍

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.

None yet

2 participants