Skip to main content
Pre-release

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

Icon diffpy.apps

PyPI Forge PythonVersion PR

CI Codecov Black Tracking

User applications to help with tasks using diffpy packages. Currently it provides: 1. Macro interface for PDF refinements. Supported by the command runmacro. 2. Agent interface for PDF refinements. Supported by the included MCP server.

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

Citation

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

diffpy.apps Package, https://github.com/diffpy/diffpy.apps

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.apps_env

conda create -n diffpy.apps_env diffpy.apps python=3.13
conda activate diffpy.apps_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.

You still need to install some of its dependencies from conda

git clone https://github.com/diffpy/diffpy.apps.git
cd diffpy.apps
conda activate diffpy.apps_env
conda install --file requirements/conda.txt

To install using pip into your diffpy.apps_env environment, type

pip install diffpy.apps

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

pip install .

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

diffpy.apps --version

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

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

To view the basic usage and available commands, type

diffpy.apps -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.apps 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.apps please visit the project web-page or email the maintainers Yuchen Xiao(yx2924@columbia.edu) and Simon Billinge(sbillinge@ucsb.edu).

Acknowledgements

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

Metadata

Release files for diffpy.apps 0.2.1rc0

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.apps 0.2.1rc0
File Size Uploaded Provenance Actions
diffpy_apps-0.2.1rc0.tar.gz 534.3 kB Without provenance Details for diffpy_apps-0.2.1rc0.tar.gz

Built distribution (wheel)

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

Total release size: 564.7 kB

Release files / diffpy_apps-0.2.1rc0.tar.gz

Download URL diffpy_apps-0.2.1rc0.tar.gz
Size 534.3 kB
Tags Source
SHA-256 checksum
How to use checksums
f1a297a61f47fab9cdd74f007843eb894e0626550b7012a969a50220c74b612b
BLAKE2b-256 checksum
How to use checksums
e8bce8300dfec03f792d9e66247e1d80334c26d3c26c591a873c5b6f63a52594
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.17

Release files / diffpy_apps-0.2.1rc0-py3-none-any.whl

Download URL diffpy_apps-0.2.1rc0-py3-none-any.whl
Size 30.5 kB
Tags Python 3
SHA-256 checksum
How to use checksums
ed8456fb92c7a07af384161f57076cd46ed31ffca1da3e0d62e0098dc0abe1d9
BLAKE2b-256 checksum
How to use checksums
9931e9e6861d96e0478da0c1077a7e1b56a55c8efa449524b7f32364bebca803
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.17

Security for diffpy.apps 0.2.1rc0

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