Skip to content

Commit

Permalink
update
Browse files Browse the repository at this point in the history
  • Loading branch information
killiansheriff committed Feb 2, 2024
1 parent 5fd6548 commit 1da5dae
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,10 @@
# Polya
A python implementation of Polya's enumeration theory (pattern inventory).
A python implementation of Polya's enumeration theory and pattern inventory formula.

# Usage

Here is an example on how to extract the cycle index polynomial (p_g) and number of distinct first coordination polyhedron (nms) for the fcc crystal structure with a number of ntypes = 3 chemical element. Additonal graph geometries can be defined in ``polya/_src/graphs.py``.

```python
from polya import Polya
polya = Polya(graph_name="fcc", ntypes=3)
Expand Down

0 comments on commit 1da5dae

Please sign in to comment.