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

added an as_supercell which returns geometry in supercell #635

Merged
merged 1 commit into from
Oct 31, 2023

Conversation

zerothi
Copy link
Owner

@zerothi zerothi commented Oct 31, 2023

This will tile the geometry and re-order the atoms such that they correspond to the supercell.

This is primarily useful for analysing real-space quantities or couplings between supercell sites.

  • Tests added
  • Documentation for functionality, docs/
  • Changes documented, CHANGELOG.md

@pfebrer as we discussed on discord, here is a method to create the supercell geometry. In the end I didn't go for returning the lattice as well. The coordinates are shifted to exactly match those of the supercell, in correct order.

@pfebrer
Copy link
Contributor

pfebrer commented Oct 31, 2023

👍

In the end I didn't go for returning the lattice as well.

You left the parameter description it in the docstring :)

@codecov
Copy link

codecov bot commented Oct 31, 2023

Codecov Report

Attention: 5 lines in your changes are missing coverage. Please review.

Comparison is base (fb8a39f) 87.73% compared to head (b3c4745) 87.73%.
Report is 9 commits behind head on main.

❗ Current head b3c4745 differs from pull request most recent head ff0177a. Consider uploading reports for the commit ff0177a to get more accurate results

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #635   +/-   ##
=======================================
  Coverage   87.73%   87.73%           
=======================================
  Files         362      362           
  Lines       48302    48318   +16     
=======================================
+ Hits        42379    42394   +15     
- Misses       5923     5924    +1     
Files Coverage Δ
src/sisl/geometry.py 86.47% <100.00%> (+0.08%) ⬆️
src/sisl/io/sile.py 83.87% <100.00%> (+0.05%) ⬆️
src/sisl/lattice.py 93.09% <ø> (ø)
src/sisl/orbital.py 90.78% <ø> (ø)
src/sisl/physics/_brillouinzone_apply.py 79.69% <100.00%> (ø)
src/sisl/tests/test_geometry.py 99.69% <100.00%> (+<0.01%) ⬆️
src/sisl/io/_multiple.py 90.55% <92.85%> (-0.86%) ⬇️
src/sisl/_dispatcher.py 69.26% <42.85%> (-1.03%) ⬇️

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

This will tile the geometry and re-order the atoms such
that they correspond to the supercell.

This is primarily useful for analysing real-space quantities
or couplings between supercell sites.

Signed-off-by: Nick Papior <[email protected]>
@zerothi zerothi force-pushed the geometry-as-supercell branch from b3c4745 to ff0177a Compare October 31, 2023 11:27
@zerothi
Copy link
Owner Author

zerothi commented Oct 31, 2023

Thanks, will merge!

@zerothi zerothi merged commit b88cf9d into main Oct 31, 2023
@zerothi zerothi deleted the geometry-as-supercell branch October 31, 2023 12:31
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.

2 participants