Skip to content

Commit ef4f14a

Browse files
authored
Update README.md
1 parent 40fa051 commit ef4f14a

File tree

1 file changed

+14
-14
lines changed

1 file changed

+14
-14
lines changed

README.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -6,36 +6,36 @@ This python program reads the diffraction angles and intensities from a PDF form
66

77
In the field of material science, X-ray diffraction(XRD) is an important method to determine if the desired crystalline phase is fabricated.
88

9-
In the laboratory, it is sufficient to compare the obtained diffraction pattern with known powder diffraction file(PDF) using the analysis software. On the other hand, to making a graph, it is useful to be able to output these PDF data as a numerical file such as CSV.
9+
In the laboratory, it is sufficient to able to compare the obtained diffraction pattern with known powder diffraction file(PDF) using the analysis software. On the other hand, when making a XRD chart, it is useful to be able to output powder diffraction data as a numerical file such as CSV.
1010

11-
Rigaku's SmartLab Studio ii is a integrated software to control XRD instrument and analyze diffraction pattern. This software can output PDF file. However, the output format is PDF(portable document file) only, and can not be output in other format such as CSV.
11+
Rigaku's SmartLab Studio ii is a integrated software to control XRD instrument and analyze diffraction pattern. This software can output powder diffraction file. However, the output format is PDF(portable document file) only, and can not be output in other format such as CSV.
1212

1313
This program supports material researchers by reads the diffraction angles and intensities from a PDF format Powder Diffraction File (PDF) output by Rigaku's SmartLab Studio ii and output these data as a CSV file.
1414

1515
## Requirements
1616

1717
- python
18+
- pandas
1819
- pdfminer.six
1920

2021
## How to use
2122

2223
```bash
2324
python3 pdf2csv.py
2425
```
25-
pdf2csv.py converts all PDF file in the same directory. The CSV files are saved on the same directory.
26-
27-
28-
```bash
29-
python3 pdf2csv.py a b...
30-
```
31-
pdf2csv.py converts a, and b. if directory is specified, all PDF files in that directory will be converted.
32-
33-
```bash
34-
python3 pdf2csv.py a b... -o c
35-
```
36-
Convert the same files as in the previous pattern. CSV files are saved on the directory C.
26+
pdf2csv.py converts all powder diffraction files in the same directory. The CSV files will be created on the same directory.
3727

3828
```bash
3929
python3 pdf2csv.py -h
4030
```
4131
Show help message.
32+
33+
## Others
34+
35+
Bug reports, feature requests, and any pull requests are always welcome.
36+
37+
## LICENSE
38+
39+
[MIT](LICENSE)
40+
41+

0 commit comments

Comments
 (0)