Citation

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

orochi.ui Package, https://github.com/Tominaka-Laboratory/orochi.ui

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

conda create -n orochi.ui_env orochi.ui
conda activate orochi.ui_env

To confirm that the installation was successful, type

python -c "import orochi.pdf_simulator; print(orochi.pdf_simulator.__version__)"

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 orochi.ui_env environment, type

pip install orochi.ui

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

pip install .

Getting Started

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

Support and Contribute

The orochi.ui 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.ui 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.ui please visit the project web-page or email Dr. Satoshi Tominaka at tominaka.satoshi@nims.go.jp.