Skip to main content

Icon diffpy.cmistructure

PyPI Forge PythonVersion PR

CI Codecov Black Tracking

diffpy.cmi package for doing refinements with structure objects

diffpy.cmistructure adapts crystal and molecular structures to the diffpy.srfit ParameterSet interface, so lattice parameters, atom positions and displacement parameters can be refined. It supports diffpy.structure.Structure, pyobjcryst crystals and molecules, and cctbx crystals. It also generates space group constraints and bond valence sum restraints.

This code was moved from diffpy.srfit.structure. If you are updating a script, see the migration guide.

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

Citation

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

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

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

conda create -n diffpy.cmistructure_env diffpy.cmistructure
conda activate diffpy.cmistructure_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.cmistructure_env environment, type

pip install diffpy.cmistructure

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

pip install .

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

diffpy-cmistructure --version

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

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

To view the basic usage and available commands, type

diffpy-cmistructure -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.cmistructure 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.cmistructure please visit the project web-page or email the maintainers Simon Billinge(sbillinge@ucsb.edu).

Acknowledgements

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

Metadata

Release files for diffpy.cmistructure 0.1.1

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.cmistructure 0.1.1
File Size Uploaded Provenance Actions
diffpy_cmistructure-0.1.1.tar.gz 43.7 kB Without provenance Details for diffpy_cmistructure-0.1.1.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for diffpy.cmistructure 0.1.1
File Interpreter ABI Platform Actions
diffpy_cmistructure-0.1.1-py3-none-any.whl Python 3 none any Details for diffpy_cmistructure-0.1.1-py3-none-any.whl

Total release size: 81.8 kB

Release files / diffpy_cmistructure-0.1.1.tar.gz

Download URL diffpy_cmistructure-0.1.1.tar.gz
Size 43.7 kB
Tags Source
SHA-256 checksum
How to use checksums
41d6eeec3d4c4871cc9b19f75945bba0252d1b75f7fa9b2bb4291638e6d38d81
BLAKE2b-256 checksum
How to use checksums
d567024d0540a0fa16f3141f938e32242f4d03685558da99bb6fa79a2aca1a51
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.16

Release files / diffpy_cmistructure-0.1.1-py3-none-any.whl

Download URL diffpy_cmistructure-0.1.1-py3-none-any.whl
Size 38.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
0c5e011927436cd44bc068cea8550ab6d43d38cb06a002d22221391a906b41f4
BLAKE2b-256 checksum
How to use checksums
42c13d7b5a427da6eb14a81f24c94fdbe850f6353e4efdd92250443607f96194
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.16

Security for diffpy.cmistructure 0.1.1

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.

Release history Release notifications | RSS feed

This release

0.1.1 This release

2 release files No provenance

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