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

Create polygon.py #988

Conversation

AbdullahKazi500
Copy link

Issue #, if available:
FIXES #969
Description of changes:
ArbitraryPolygonCanvas
Provides support for canvases defined by arbitrary polygons, allowing more flexibility in defining the spatial constraints for atom arrangements.
Methods:
init(self, vertices: List[Tuple[float, float]]): Initializes the canvas with a list of vertices defining the polygon.
is_within(self, point: Tuple[float, float]) -> bool: Checks if a given point is within the polygon.

Class Methods Update:
from_decorated_bravais_lattice:
Updated to accept a canvas parameter that can be either a RectangularCanvas or an ArbitraryPolygonCanvas.
Functionality:
Uses lattice vectors and decoration points to generate atom arrangements within the given canvas.
For ArbitraryPolygonCanvas, it utilizes the polygon bounds and is_within method to ensure points are within the arbitrary polygon.
from_honeycomb_lattice:
Updated to accept a canvas parameter that can be either a RectangularCanvas or an ArbitraryPolygonCanvas.
Functionality: Uses specific lattice vectors and decoration points for a honeycomb lattice structure within the given canvas.
from_bravais_lattice:
Updated to accept a canvas parameter that can be either a RectangularCanvas or an ArbitraryPolygonCanvas.
Functionality: Uses provided lattice vectors to generate atom arrangements within the given canvas.

Example Initialization:
Provided example usage for both RectangularCanvas and ArbitraryPolygonCanvas with the AtomArrangement class.
Demonstrates how to create an AtomArrangement using a honeycomb lattice within an arbitrary polygon canvas.
Validation:
Prints the number of atoms arranged within the defined canvas to validate functionality.
Testing done:
no

Merge Checklist

Put an x in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your pull request.

General

Tests

  • I have added tests that prove my fix is effective or that my feature works (if appropriate)
  • I have checked that my tests are not configured for a specific region or account (if appropriate)

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

@peterkomar-aws
Copy link
Contributor

Please consolidate the work to this PR: #989

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.

Factory methods for AHS AtomArrangments
2 participants