Key Features

• Detector Geometry Calibration: Refines incident beam center (x₀, y₀), calibrated sample-to-detector distance L₀, and detector tilt/rotation angles against standard calibration materials (SRM CeO₂, Ni).

• Physical Sensor Corrections: Corrects for beam polarization, solid-angle distortion, detector thickness oblique absorption (μ_det · t_det), and capillary sample attenuation.

• Automated Beamstop & Defect Masking: Automatically identifies circular beamstop shadows, inter-module gaps, and dead pixels.

• Diagonal Sector Integration: Integrates over designated diagonal corner lobes (β = ±45° ± 18°, ±135° ± 18°), avoiding orthogonal detector edge boundaries to access maximum momentum transfer Q_max with invariant angular acceptance.

Citation

If you use orochi.pixia in a scientific publication, please cite this package as:

S. Tominaka, Orochi: A Physics-Grounded Python Package for Pair Distribution Function Analysis of Crystalline and Low-Dimensional Materials, 2026. https://github.com/Tominaka-Laboratory/orochi.pixia

Installation

The preferred method is to install using pip:

pip install orochi.pixia

To confirm that the installation was successful, type:

python -c "import orochi.pixia; print('Orochi PIXIA imported successfully')"

If you prefer to install from source:

git clone https://github.com/Tominaka-Laboratory/orochi.pixia.git
cd orochi.pixia
pip install -e .

Getting Started

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

Support and Contribute

The orochi.pixia project welcomes your expertise and enthusiasm!

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 orochi.pixia 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.

Improvements and fixes are always appreciated.

Before contributing, please read our Code of Conduct.

License

This project is licensed under the GNU General Public License v3.0 (GPLv3). See the LICENSE.rst file for details.

This copyleft license guarantees that Orochi remains freely accessible, open, and transparent to the entire scientific community, and that all derivative works must likewise remain open source.

Citation

If you use this package in academic research, please cite:

@article{tominaka2026orochi,
  title   = {Orochi: A Physics-Grounded Python Package for Pair Distribution Function Analysis of Crystalline and Low-Dimensional Materials},
  author  = {Tominaka, Satoshi},
  year    = {2026},
  url     = {https://github.com/Tominaka-Laboratory/orochi}
}

Contact

For more information on orochi.pixia please visit the project web-page or email Dr. Satoshi Tominaka at tominaka.satoshi@nims.go.jp.