Skip to main content
Pre-release

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

Icon diffpy.cmirietveld

PyPI Forge PythonVersion PR

CI Codecov Black Tracking

A pack for diffpy.cmi that allows it to do Rietveld refinement of powder diffraction data

  • LONGER DESCRIPTION HERE

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

Citation

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

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

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

conda create -n diffpy.cmirietveld_env diffpy.cmirietveld
conda activate diffpy.cmirietveld_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.cmirietveld_env environment, type

pip install diffpy.cmirietveld

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

pip install .

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

diffpy.cmirietveld --version

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

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

To view the basic usage and available commands, type

diffpy.cmirietveld -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.cmirietveld 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.cmirietveld please visit the project web-page or email the maintainers Simon Billinge(sbillinge@ucsb.edu) and Caden Myers(cjm2304@columbia.edu).

Acknowledgements

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

Metadata

Release files for diffpy.cmirietveld 0.1.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.cmirietveld 0.1.0rc0
File Size Uploaded Provenance Actions
diffpy_cmirietveld-0.1.0rc0.tar.gz 2.5 MB Without provenance Details for diffpy_cmirietveld-0.1.0rc0.tar.gz

Built distribution (wheel)

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

Total release size: 2.6 MB

Release files / diffpy_cmirietveld-0.1.0rc0.tar.gz

Download URL diffpy_cmirietveld-0.1.0rc0.tar.gz
Size 2.5 MB
Tags Source
SHA-256 checksum
How to use checksums
67e57c5d4d89edc0657d2824658e25724be2831f1419bff61f24259866f245c0
BLAKE2b-256 checksum
How to use checksums
44f437fa2e28559e2a89f2f36cff0f5aef740841a450b5b199db0c743af5f8b0
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.18

Release files / diffpy_cmirietveld-0.1.0rc0-py3-none-any.whl

Download URL diffpy_cmirietveld-0.1.0rc0-py3-none-any.whl
Size 34.8 kB
Tags Python 3
SHA-256 checksum
How to use checksums
43bc5e4b328bc062cae938a7917c1b814f2eff4fef6dc9a87f7841ec7c7d19c6
BLAKE2b-256 checksum
How to use checksums
a392278af1cc4b5c8fd61f5d0fe28472efaaef2116ad6373cdbb8d7bd6b57744
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.18

Security for diffpy.cmirietveld 0.1.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