https://github.com/aimat-lab/xrdpattern
Python library for XrdPatterns including file import, file export and postprocessing functionalities
https://github.com/aimat-lab/xrdpattern
diffraction-pattern powder-diffraction
Last synced: 11 days ago
JSON representation
Python library for XrdPatterns including file import, file export and postprocessing functionalities
- Host: GitHub
- URL: https://github.com/aimat-lab/xrdpattern
- Owner: aimat-lab
- License: lgpl-2.1
- Created: 2024-02-08T18:44:44.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2025-09-03T08:27:56.000Z (5 months ago)
- Last Synced: 2025-11-29T01:33:50.237Z (3 months ago)
- Topics: diffraction-pattern, powder-diffraction
- Language: C++
- Homepage:
- Size: 17.2 MB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
## About
Python library for handling XrdPatterns including support for importing from data files, exporting as json file, visualization and postprocessing.
The data file import functionalities are largely built on the C++ library [xylib](https://github.com/wojdyr/xylib) so beyond a standard python install this library also requires:
- A C++ compiler and standard library
- A C++ to python bridge (Swig)
## Installation
### System level requirements
For Ubuntu 22.04:
```
sudo apt install build-essential # GNU C++ compiler
sudo apt install libboost-all-dev # C++ libraries provided by Boost
sudo apt install swig # python -> C++ bridge
```
For Windows >10 you may try the following in PowerShell (requires [Chocolatey](https://chocolatey.org/)):
```
choco install mingw # C++ compiler and std library
choco install swig # python -> C++ bridge
```
### Python library
Once the system level requirements are installed, the library can be installed using pip:
```
pip install xrdpattern
```
## Supported formats
Loading Diffractogram patterns from the following data formats is supported:
- Plain Text Files
- Comma seperated values (.csv)
- Two column data (.xy)
- Crystallographic Information File for Powder Diffraction (.cif)
- Custom XrdPattern json format (.json)
- Plain text tab seperated values (.txt) (! In progress)
- PANalytical XRDML (.xrdml)
- Freiberg Instruments XSYG (.xysg)
- Binaries:
- Siemens/Bruker RAW ver. 1/2/3/4 (.raw)
- Stoe RAW (.raw) (! In progress)
- Siemens/Bruker UXD (.uxd)
- Philips UDF (.udf)
- Philips RD ver. 3/5 (.rd)
- Rigaku DAT (.dat)
- RIET7 DAT (.dat)
- Sietronics Sieray CPI (.cpi)
- XFIT/Koalariet XDD (.xdd)
- DBWS/DMPLOT data file (.dbw, .rit, .neu)
- Canberra CNF (.cnf)
- Canberra AccuSpec MCA (.mca)
- χPLOT CHI (.chi)
- Bruker SPC (.spc)
When using Xrdpattern.load(fpath=xrdfile.suffix), the format will be automatically determined from the suffix unless
there are are several formats with this format as with .raw and .dat.
In this case the format will need to be manually specified.