Skip to content

Commit

Permalink
prep for pyxtal-1.0.6
Browse files Browse the repository at this point in the history
  • Loading branch information
qzhu2017 committed Dec 7, 2024
1 parent dadac4e commit f0205db
Show file tree
Hide file tree
Showing 5 changed files with 37 additions and 4 deletions.
17 changes: 17 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,23 @@ author = "Scott Fredericks and Kevin Parrish and Dean Sayre and Qiang Zhu",
}
```

### Site Symmetry Representation
Levy D, Panigrahi S-S, Kaba S-O, Zhu Q, Galkin M, Miret S, Ravanbakhsh S. (2024)
[SymmCD: Symmetry-Preserving Crystal Generation with Diffusion Models AI for Accelerated Materials Design](https://openreview.net/forum?id=V7x2KZQn2v)
NeurIPS 2024,

```bib
@inproceedings{
levy2024symmcd,
title={Symm{CD}: Symmetry-Preserving Crystal Generation with Diffusion Models},
author={Daniel Levy and Siba Smarak Panigrahi and S{\'e}kou-Oumar Kaba and Qiang Zhu and Mikhail Galkin and Santiago Miret and Siamak Ravanbakhsh},
booktitle={AI for Accelerated Materials Design - NeurIPS 2024},
year={2024},
url={https://openreview.net/forum?id=V7x2KZQn2v}
}
```


### Symmetry relation
Zhu Q, Kang B, Parrish K (2022).
[Symmetry Relation Database and Its Application to Ferroelectric Materials Discovery](https://link.springer.com/article/10.1557/s43579-022-00268-4)
Expand Down
16 changes: 16 additions & 0 deletions doc/Usage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1300,3 +1300,19 @@ Finally, the both Group and Wyckoff_position classes support the access of the s
Note that the space group symmetry has 26 symmetry elements as it includes additional screw axis (`2_1`, `3_1`, `3_2`, `4_1`, `4_2`, `4_3`, `6_1`, `6_2`, `6_3, `6_4`, `6_5`) and glide plane (`a`, `b`, `c`, `d`, `n`) operations.
For the use of this function, please cite the following paper.
::
@inproceedings{
levy2024symmcd,
title={Symm{CD}: Symmetry-Preserving Crystal Generation with Diffusion Models},
author={Daniel Levy and Siba Smarak Panigrahi and S{\'e}kou-Oumar Kaba and Qiang Zhu and Mikhail Galkin and Santiago Miret and Siamak Ravanbakhsh},
booktitle={AI for Accelerated Materials Design - NeurIPS 2024},
year={2024},
url={https://openreview.net/forum?id=V7x2KZQn2v}
}
4 changes: 2 additions & 2 deletions doc/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -34,9 +34,9 @@ def __getattr__(cls, name):
author = "Qiang Zhu, Scott Fredericks, Kevin Parrish"

# The short X.Y version
version = "1.0.5"
version = "1.0.6"
# The full version, including alpha/beta/rc tags
release = "1.0.5"
release = "1.0.6"

# -- General configuration ---------------------------------------------------

Expand Down
2 changes: 1 addition & 1 deletion doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ ab-initio generation of random crystal structures. It has the following features
- Structural manipulation via symmetry relation (both subgroup and supergroup)
- Geometry optimization from built-in and external optimization methods

The current version is ``1.0.5`` at `GitHub <https://github.com/MaterSim/PyXtal>`_.
The current version is ``1.0.6`` at `GitHub <https://github.com/MaterSim/PyXtal>`_.
It is available for use under the MIT license. Expect updates upon request by
`Qiang Zhu\'s group <https://qzhu2017.github.io>`_ at the
University of North Carolina at Charlotte.
Expand Down
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ def run(self):

setup(
name="pyxtal",
version="1.0.5",
version="1.0.6",
author="Scott Fredericks, Kevin Parrish, Qiang Zhu",
author_email="[email protected]",
description="Python code for generation of crystal structures based on symmetry constraints.",
Expand Down

0 comments on commit f0205db

Please sign in to comment.