[Code scan] Fix VASP tutorial commands and parsed output paths

Đang mở Phù hợp với người mới
  • Có gì không ổn?
#44 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

Đánh giá

Độ khó
2/5
Thời gian dự kiến
1-2 ngày
Mức phù hợp với người mới
78/100
Loại issue
Tài liệu
Độ rõ ràng
Đặc tả rõ ràng
Mức độ hoạt động
Ít trao đổi
Công nghệ
python
Lĩnh vực
documentation

Hướng nghiên cứu

Bắt đầu với các phần lệnh VASP trong docs/user-guide/quickstart.md và docs/tutorials/plot_bands.md, sau đó đối chiếu chúng với dftio/io/parse.py, dftio/io/vasp/vasp_parser.py và dftio/plot/plot_eigs.py. Chạy các lệnh parse và band được ghi trong tài liệu để xác minh việc discovery và các đường dẫn đầu ra. Được xem là hoàn tất khi các ví dụ sử dụng đúng root, prefix, eigenvalue option, thư mục formula.0 và tên tệp band_structure.png.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

This issue comes from a Codex global repository scan.

Problem

The VASP quickstart points --root at a single calculation directory and uses an empty prefix:

https://github.com/deepmodeling/dftio/blob/c9d128f24a74ef2911e1a28f5640357488beb196/docs/user-guide/quickstart.md#L21-L28

The parser discovers calculations with glob(os.path.join(root, '*' + prefix + '*')):

https://github.com/deepmodeling/dftio/blob/c9d128f24a74ef2911e1a28f5640357488beb196/dftio/io/parse.py#L64-L67

With --root example/vasp/GaAs --prefix "", discovery returns files like EIGENVAL and POSCAR, then the VASP parser tries to read EIGENVAL/POSCAR:

https://github.com/deepmodeling/dftio/blob/c9d128f24a74ef2911e1a28f5640357488beb196/dftio/io/vasp/vasp_parser.py#L25-L28

The band tutorial has the same root issue and also omits --eigenvalue:

https://github.com/deepmodeling/dftio/blob/c9d128f24a74ef2911e1a28f5640357488beb196/docs/tutorials/plot_bands.md#L16-L21

The docs also describe a top-level 0.dat, but write_dat() creates <formula>.<idx>/cell.dat, kpoints.npy, and eigenvalues.npy:

https://github.com/deepmodeling/dftio/blob/c9d128f24a74ef2911e1a28f5640357488beb196/dftio/io/parse.py#L251-L267

dftio band -r ./parsed_data points one directory too high, and the plot file is band_structure.png:

https://github.com/deepmodeling/dftio/blob/c9d128f24a74ef2911e1a28f5640357488beb196/dftio/plot/plot_eigs.py#L60-L91

Suggested fix

Use a command like --root example/vasp --prefix GaAs --eigenvalue, document the generated <formula>.0 subdirectory, and point dftio band -r at that subdirectory. Update the expected plot filename to band_structure.png.

Ngôn ngữ chính
Jupyter Notebook
Star
16
Fork
14
Không có pull request nào được merge trong 30 ngày

Chuẩn bị môi trường

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của deepmodeling/dftio

Tất cả issue của deepmodeling/dftio

Issue tương tự

Thêm issue về Documentation

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.