Skip to content

Commit

Permalink
readme
Browse files Browse the repository at this point in the history
  • Loading branch information
RyotaroOKabe committed Sep 25, 2024
1 parent 172d58f commit 20c4423
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ To run phonon predictions on your own materials using the pre-trained models, us
- `cif_MVN.ipynb`
- `cif_kMVN.ipynb`

Store your CIF files in the `./cif_folder/`. The Jupyter notebooks will load the materials from this folder and perform the prediction. Use the `idx_out` variable to specify which material to plot the results for.
Store your CIF files in the `./cif_folder/`. The Jupyter notebooks will load the materials from this folder and perform the prediction. Seekpath automatically suggest the high-symmetry path for kMVN. Use the `idx_out` variable to specify which material to plot the results for.

---

Expand Down Expand Up @@ -113,11 +113,13 @@ If you find this code or dataset useful, please cite the following paper:
```

## [6] References
**Publication:** Zhantao Chen, Nina Andrejevic, *et al.* "Virtual Node Graph Neural Network for Full Phonon
**Architecture:** Zhantao Chen, Nina Andrejevic, *et al.* "Virtual Node Graph Neural Network for Full Phonon
Prediction." Adv. Sci. 8, 2004214 (2021). https://onlinelibrary.wiley.com/doi/10.1002/advs.202004214.

**E(3)NN:** Mario Geiger, Tess Smidt, Alby M., Benjamin Kurt Miller, *et al.* Euclidean neural networks: e3nn (2020) v0.4.2. https://doi.org/10.5281/zenodo.5292912.

**seekpath:** Y. Hinuma, G. Pizzi, Y. Kumagai, F. Oba, I. Tanaka, Band structure diagram paths based on crystallography, Comp. Mat. Sci. 128, 140 (2017) https://seekpath.readthedocs.io/en/latest/index.html.

**Dataset:** Guido Petretto, Shyam Dwaraknath, Henrique P. C. Miranda, Donald Winston, *et al.* "High-throughput Density-Functional Perturbation Theory phonons for inorganic materials." (2018) figshare. Collection. https://doi.org/10.6084/m9.figshare.c.3938023.v1

## [7] Data Availability Statement
Expand Down

0 comments on commit 20c4423

Please sign in to comment.