Skip to main content
Pre-release

This release is a pre-release and may not be stable for production use.

Icon diffpy.labpdfproc

PyPI Forge PythonVersion PR

CI Codecov Black Tracking

Tools for processing x-ray powder diffraction data from laboratory sources.

PDFgetX3 has revolutionized how PDF methods can be applied to solve nanostructure problems. However, the program was designed for use with Rapid Acquisition PDF (RAPDF) data from synchrotron sources. A key approximation inherent in the use of PDFgetX3 for RAPDF data is that absorption effects are negligible. This is typically not the case for laboratory x-ray diffractometers, where absorption effects can be significant.

This app is designed to preprocess data from laboratory x-ray diffractometers before using PDFgetX3 to obtain PDFs. The app currently carries out an absorption correction assuming a parallel beam capillary geometry which is the most common geometry for lab PDF measurements.

The theory is described in the following paper:

Chen, Y., Schertenleib, T., Yang, A., Schouwink, P., Queen, W. L., and Billinge, S. J. L., Absorption Correction for Reliable Pair Distribution Functions from Low Energy X-ray Sources. Crystal Growth & Design, 2026, 26 (3), 1036–1047. https://doi.org/10.1021/acs.cgd.5c00551

The related experimental data acquisition protocols are described in the following paper:

Schertenleib, T., Schmuckler, D., Chen, Y., Jin, G. B., Queen, W. L., and Billinge, S. J. L. (2025). Testing Protocols for Obtaining Reliable Pair Distribution Functions from Laboratory X-Ray Sources Using PDFgetX3. Chem. Methods, 2500001. https://doi.org/10.1002/cmtd.202500001

For more information about the diffpy.labpdfproc library, please consult our online documentation.

Citation

If you use diffpy.labpdfproc in a scientific publication, we would like you to cite this package as

Chen, Y., Schertenleib, T., Yang, A., Schouwink, P., Queen, W. L., and Billinge, S. J. L., Absorption Correction for Reliable Pair Distribution Functions from Low Energy X-ray Sources. Crystal Growth & Design, 2026, 26 (3), 1036–1047. https://doi.org/10.1021/acs.cgd.5c00551

Installation

The preferred method is to use Miniconda Python and install from the “conda-forge” channel of Conda packages.

To add “conda-forge” to the conda channels, run the following in a terminal.

conda config --add channels conda-forge

We want to install our packages in a suitable conda environment. The following creates and activates a new environment named diffpy.labpdfproc_env

conda create -n diffpy.labpdfproc_env diffpy.labpdfproc
conda activate diffpy.labpdfproc_env

The output should print the latest version displayed on the badges above.

If the above does not work, you can use pip to download and install the latest release from Python Package Index. To install using pip into your diffpy.labpdfproc_env environment, type

pip install diffpy.labpdfproc

If you prefer to install from sources, after installing the dependencies, obtain the source archive from GitHub. Once installed, cd into your diffpy.labpdfproc directory and run the following

pip install .

This package also provides command-line utilities. To check the software has been installed correctly, type

labpdfproc --version

You can also type the following command to verify the installation.

python -c "import diffpy.labpdfproc; print(diffpy.labpdfproc.__version__)"

To view the basic usage and available commands, type

labpdfproc -h

Getting Started

You may consult our online documentation for tutorials and API references.

Support and Contribute

If you see a bug or want to request a feature, please report it as an issue and/or submit a fix as a PR.

Feel free to fork the project and contribute. To install diffpy.labpdfproc in a development mode, with its sources being directly used by Python rather than copied to a package directory, use the following in the root directory

pip install -e .

To ensure code quality and to prevent accidental commits into the default branch, please set up the use of our pre-commit hooks.

  1. Install pre-commit in your working environment by running conda install pre-commit.

  2. Initialize pre-commit (one time only) pre-commit install.

Thereafter your code will be linted by black and isort and checked against flake8 before you can commit. If it fails by black or isort, just rerun and it should pass (black and isort will modify the files so should pass after they are modified). If the flake8 test fails please see the error messages and fix them manually before trying to commit again.

Improvements and fixes are always appreciated.

Before contributing, please read our Code of Conduct.

Contact

For more information on diffpy.labpdfproc please visit the project web-page or email the maintainers Simon Billinge(sbillinge@ucsb.edu).

Acknowledgements

diffpy.labpdfproc is built and maintained with scikit-package.

Metadata

Release files for diffpy.labpdfproc 0.4.0rc0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for diffpy.labpdfproc 0.4.0rc0
File Size Uploaded Provenance Actions
diffpy_labpdfproc-0.4.0rc0.tar.gz 47.9 kB Without provenance Details for diffpy_labpdfproc-0.4.0rc0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for diffpy.labpdfproc 0.4.0rc0
File Interpreter ABI Platform Actions
diffpy_labpdfproc-0.4.0rc0-py3-none-any.whl Python 3 none any Details for diffpy_labpdfproc-0.4.0rc0-py3-none-any.whl

Total release size: 85.7 kB

Release files / diffpy_labpdfproc-0.4.0rc0.tar.gz

Download URL diffpy_labpdfproc-0.4.0rc0.tar.gz
Size 47.9 kB
Tags Source
SHA-256 checksum
How to use checksums
865887f042f7af4941da89d0839ac7dcc53341f8ac6ead0095ac4bf731a9784c
BLAKE2b-256 checksum
How to use checksums
2b770cbf32af8e82860f978f88a2a68e7458bb4ff8a971bc3513a53eb2aeac0c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.14.10

Release files / diffpy_labpdfproc-0.4.0rc0-py3-none-any.whl

Download URL diffpy_labpdfproc-0.4.0rc0-py3-none-any.whl
Size 37.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
f63eeec7da61183806215c825e536cb3e23f034c0fb35776d1f9b96c20e246ac
BLAKE2b-256 checksum
How to use checksums
5d288382e856fa07b2e27f27aeadbaf12a96d200c9a16d842fd2155a4dd8c7ea
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.14.10

Security for diffpy.labpdfproc 0.4.0rc0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page