caobin commited on
Commit
910a272
·
verified ·
1 Parent(s): dcab3eb

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +31 -30
README.md CHANGED
@@ -1,41 +1,42 @@
1
- ---
2
- license: apache-2.0
3
- language:
4
- - en
5
- pretty_name: CGWGAN
6
- ---
7
 
8
- + site template : open.db.gz
9
- + M3GNet-calculated phonon : merge.db
10
 
 
 
 
 
11
 
12
- ## Crystal Generative Framework based on Wyckoff Generative Adversarial Network
13
- In this study, we present the Crystal Generative framework based on the Wyckoff Generative Adversarial Network (CGWGAN)
 
14
 
 
 
15
 
16
- All templates with 3-4 asymmetric units generated in our work are available as open-source resources on the datasets CGWGAN.
17
 
18
- ## Python Implementation
19
 
20
- ```
21
  from ase.db import connect
22
 
23
  database = connect('open.db')
24
- entry_id = 1 # the crystal index
25
- atoms = database.get_atoms(id=_id)
26
 
27
- # chemical symbols
28
  symbols = atoms.get_chemical_symbols()
29
- # volume
30
  latt_vol = atoms.get_volume()
31
- # fractional positions
32
  positions = atoms.get_scaled_positions()
33
- # etc ...
34
  ```
35
 
36
- ## Operate and display db file
37
- ```
38
- # pip install CryDBkit
 
39
 
40
  from CryDBkit import website
41
 
@@ -43,12 +44,12 @@ website.show('open.db')
43
  ```
44
 
45
  ```
46
- @misc {caobin_2024,
47
- author = { {caobin} },
48
- title = { CGWGAN (Revision 3415d7a) },
49
- year = 2024,
50
- url = { https://huggingface.co/datasets/caobin/CGWGAN },
51
- doi = { 10.57967/hf/3002 },
52
- publisher = { Hugging Face }
53
  }
54
- ```
 
 
 
 
 
 
 
1
 
2
+ ---
 
3
 
4
+ license: apache-2.0
5
+ language:
6
+ - en
7
+ pretty_name: CGWGAN
8
 
9
+ + Site Template: open.db.gz
10
+ + M3GNet-Calculated Phonon: merge.db
11
+ + VASP Relaxation Structure Comparison with PyXtal: random_vs.db
12
 
13
+ ## Crystal Generative Framework Based on Wyckoff Generative Adversarial Network
14
+ In this study, we present the Crystal Generative Framework based on the Wyckoff Generative Adversarial Network (CGWGAN).
15
 
16
+ All templates with 3-4 asymmetric units generated in our work are available as open-source resources in the CGWGAN datasets.
17
 
18
+ ## Python Implementation
19
 
20
+ ```python
21
  from ase.db import connect
22
 
23
  database = connect('open.db')
24
+ entry_id = 1 # The crystal index
25
+ atoms = database.get_atoms(id=entry_id)
26
 
27
+ # Chemical symbols
28
  symbols = atoms.get_chemical_symbols()
29
+ # Volume
30
  latt_vol = atoms.get_volume()
31
+ # Fractional positions
32
  positions = atoms.get_scaled_positions()
33
+ # etc...
34
  ```
35
 
36
+ ## Operating and Displaying the DB File
37
+ ```bash
38
+ # Install CryDBkit
39
+ pip install CryDBkit
40
 
41
  from CryDBkit import website
42
 
 
44
  ```
45
 
46
  ```
47
+ @misc{caobin_2024,
48
+ author = {Cao Bin},
49
+ title = {CGWGAN (Revision 3415d7a)},
50
+ year = 2024,
51
+ url = {https://huggingface.co/datasets/caobin/CGWGAN},
52
+ doi = {10.57967/hf/3002},
53
+ publisher = {Hugging Face}
54
  }
55
+ ```