qiskit-community / qiskit-nature / 6070308454

86%

push

github

Add `KagomeLattice` class (#1038)

* feat: add kagome lattice draft implementation

* chore: add unit tests

* fix: docstrings

* feat: shift nodes so that edges can seen for periodic boundary conditions

* fix: restore `_coordinate_to_index` for uniformity

* chore: add release note

* chore: lint

* fix: add 'kagome' to pylint dictionary

* fix: years in copyright headers

* fix: remove ascii kagome lattice

* Apply suggestions from code review

Co-authored-by: Max Rossmannek <max.rossmannek@uzh.ch>

* Apply suggestions from code review

Co-authored-by: Max Rossmannek <max.rossmannek@uzh.ch>

* fix: explicit documentation for `rows` and `cols` arguments

* chore: move over identical settings between the two subtests to `setUp`

* chore: expose relevant internal instance variables as read-only

* chore: appropriately demarcate class attributes and instance attributes

* fix: docstrings

* chore: expand docstring for class

* fix: typos

* chore: update dictionary

* fix: incorrect primitive basis

* Update test/second_q/hamiltonians/lattices/test_kagome_lattice.py

Co-authored-by: Max Rossmannek <max.rossmannek@uzh.ch>

* Apply suggestions from code review

Co-authored-by: Max Rossmannek <max.rossmannek@uzh.ch>

* Apply suggestions from code review

Co-authored-by: Max Rossmannek <max.rossmannek@uzh.ch>

* Apply suggestions from code review

Co-authored-by: Max Rossmannek <max.rossmannek@uzh.ch>

* chore: add usage example to release note

* Apply suggestions from code review

Co-authored-by: Max Rossmannek <max.rossmannek@uzh.ch>

* fix: typo

* chore: lint and format

* Apply suggestions from code review

Co-authored-by: Max Rossmannek <max.rossmannek@uzh.ch>

* chore: apply suggestions from code review

* removes redundant `with_boundaries` optional parameter
* moves `__init__` above all private methods
* removes various variable duplication
* fixes docstrings
* make... (continued)

166 of 166 new or added lines in 2 files covered. (100.0%)

9948 of 11331 relevant lines covered (87.79%)

0.88 hits per line