A package containing file readers for XRD raw files.
Project description
fairmat-readers-xrd
A package developed by FAIRmat and collaborators that contains file readers for various X-ray diffraction (XRD) file formats.
Install and use
To use the readers, install the package using pip
and import the read_file
function. It will check the file extension and, using an appropriate file
reader, return a Python dictionary containing the data.
pip install fairmat-readers-xrd
from fairmat_readers_xrd import read_file
file_path = "<filepath>.xrdml"
data_dict = read_file(file_path)
You can also import individual file readers.
from fairmat_readers_xrd import read_panalytical_xrdml
file_path = "<filepath>.xrdml"
data_dict = read_panalytical_xrdml(file_path)
Currently, the following file extensions are supported:
File Extension | Corresponding Reader Function |
---|---|
.xrdml |
read_panalytical_xrdml |
.rasx |
read_rigaku_rasx |
.brml |
read_bruker_brml |
Development
The package is still under development. To contribute, start with simply raising an issue on the repo. In case you want to contribute a piece of code, or a whole new reader, clone the repo in your local and start a virtual Python environment inside the directory.
git clone git@github.com:FAIRmat-NFDI/readers-xrd.git
cd readers-xrd
python3.9 -m venv .pyenv
source .pyenv/bin/activate
Then install the package in editable mode (-e flag), with dev
dependencies.
You can also run the pytest
to confirm all went well.
python -m pip install --upgrade pip
pip install -e .[dev]
pytest
Now you can start tinkering around. We recommend to create a new branch for this. If you want to contribute the code back to the upstream, simply create a Pull Request (PR), and we will get back to you. As a good practice, add tests for new readers and make sure existing tests are passing before creating PR.
You can also use Ruff
for automatic linting by running the following:
ruff format .
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for fairmat_readers_xrd-0.0.3.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | aaea11b6c8520400bfd4381d24f249c4fe7d687367c264704991511798f87d9d |
|
MD5 | ba51a8d169a4cfe76c3d8bc5fb337b6d |
|
BLAKE2b-256 | 8d94e66f9156769b7a20eba4d9e72ddc0b1b5d3836f2cf14d3212ad08e03c9af |
Hashes for fairmat_readers_xrd-0.0.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c4fbf7ab079270b3f1375f4d81214de784cebecb1d3823f2d03eada6aa75a565 |
|
MD5 | 0374717c011ed7155aeab731c22726ba |
|
BLAKE2b-256 | 7eb13069f1ab509f8e3c9a74e6532f007526ad89b0dd2085093cee2ada35dca4 |