|Icon| |title|_
===============
.. |title| replace:: diffpy.cmi
.. _title: https://diffpy.github.io/diffpy.cmi
.. |Icon| image:: https://avatars.githubusercontent.com/diffpy
:target: https://diffpy.github.io/diffpy.cmi
:height: 100px
|PyPI| |Forge| |PythonVersion| |PR|
|CI| |Codecov| |Black| |Tracking|
.. |Black| image:: https://img.shields.io/badge/code_style-black-black
:target: https://github.com/psf/black
.. |CI| image:: https://github.com/diffpy/diffpy.cmi/actions/workflows/matrix-and-codecov-on-merge-to-main.yml/badge.svg
:target: https://github.com/diffpy/diffpy.cmi/actions/workflows/matrix-and-codecov-on-merge-to-main.yml
.. |Codecov| image:: https://codecov.io/gh/diffpy/diffpy.cmi/branch/main/graph/badge.svg
:target: https://codecov.io/gh/diffpy/diffpy.cmi
.. |Forge| image:: https://img.shields.io/conda/vn/conda-forge/diffpy.cmi
:target: https://anaconda.org/conda-forge/diffpy.cmi
.. |PR| image:: https://img.shields.io/badge/PR-Welcome-29ab47ff
.. |PyPI| image:: https://img.shields.io/pypi/v/diffpy.cmi
:target: https://pypi.org/project/diffpy.cmi/
.. |PythonVersion| image:: https://img.shields.io/pypi/pyversions/diffpy.cmi
:target: https://pypi.org/project/diffpy.cmi/
.. |Tracking| image:: https://img.shields.io/badge/issue_tracking-github-blue
:target: https://github.com/diffpy/diffpy.cmi/issues
Complex modeling infrastructure: a modulare framework for multi-modal modeling of scientific data.
DiffPy.CMI is designed as an extensible complex modeling infrastructure. Users and developers can readily integrate novel data types and constraints into custom workflows. While widely used for advanced analysis of structural data, the framework is general and can be applied to any problem where model parameters are refined to fit calculated quantities to data.
DiffPy.CMI is a community-driven project that supports Unix, Linux, macOS, and Windows platforms. It is designed to be used in Python scripts enabling flexible scripting and automation for advanced and reproducible workflows. Users are encouraged to leverage the software for their modeling needs and to contribute feedback, use cases, and extensions through the project community.
For more information about the diffpy.cmi library, please consult our `online documentation <https://diffpy.github.io/diffpy.cmi>`_.
Citation
--------
If you use diffpy.cmi in a scientific publication, we would like you to cite this package as
Juhás, P.; Farrow, C. L.; Yang, X.; Knox, K. R.; Billinge, S. J. L. Complex Modeling: A Strategy and Software Program for Combining Multiple Information Sources to Solve Ill Posed Structure and Nanostructure Inverse Problems. Acta Crystallogr A Found Adv 2015, 71 (6), 562–568. https://doi.org/10.1107/S2053273315014473.
Installation
------------
The preferred method is to use `Miniconda Python
<https://docs.conda.io/projects/miniconda/en/latest/miniconda-install.html>`_
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.cmi_env`` ::
conda create -n diffpy.cmi_env diffpy.cmi
conda activate diffpy.cmi_env
To confirm that the installation was successful, type ::
python -c "import diffpy.cmi; print(diffpy.cmi.__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 <https://pypi.python.org>`_.
To install using ``pip`` into your ``diffpy.cmi_env`` environment, type ::
pip install diffpy.cmi
If you prefer to install from sources, after installing the dependencies, obtain the source archive from
`GitHub <https://github.com/diffpy/diffpy.cmi/>`_. Once installed, ``cd`` into your ``diffpy.cmi`` directory
and run the following ::
pip install .
Getting Started
---------------
You may consult our `online documentation <https://diffpy.github.io/diffpy.cmi>`_ 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 <https://github.com/diffpy/diffpy.cmi/issues>`_ and/or `submit a fix as a PR <https://github.com/diffpy/diffpy.cmi/pulls>`_.
Feel free to fork the project and contribute. To install diffpy.cmi
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 <https://github.com/diffpy/diffpy.cmi/blob/main/CODE_OF_CONDUCT.rst>`_.
Contact
-------
For more information on diffpy.cmi please visit the project `web-page <https://diffpy.github.io/>`_ or email Simon Billinge at sb2896@columbia.edu.
Acknowledgements
----------------
``diffpy.cmi`` is built and maintained with `scikit-package <https://scikit-package.github.io/scikit-package/>`_.
Raw data
{
"_id": null,
"home_page": null,
"name": "diffpy.cmi",
"maintainer": null,
"docs_url": null,
"requires_python": "<3.14,>=3.11",
"maintainer_email": "Simon Billinge <sb2896@columbia.edu>",
"keywords": "modelling, regression, diffraction, PDF, complex-modeling",
"author": null,
"author_email": "Simon Billinge <sb2896@columbia.edu>",
"download_url": "https://files.pythonhosted.org/packages/79/97/554774413af70c3d054c83e648cda9f841e65f6a240bc24d4ef35a59f45b/diffpy_cmi-0.0.1.tar.gz",
"platform": null,
"description": "|Icon| |title|_\n===============\n\n.. |title| replace:: diffpy.cmi\n.. _title: https://diffpy.github.io/diffpy.cmi\n\n.. |Icon| image:: https://avatars.githubusercontent.com/diffpy\n :target: https://diffpy.github.io/diffpy.cmi\n :height: 100px\n\n|PyPI| |Forge| |PythonVersion| |PR|\n\n|CI| |Codecov| |Black| |Tracking|\n\n.. |Black| image:: https://img.shields.io/badge/code_style-black-black\n :target: https://github.com/psf/black\n\n.. |CI| image:: https://github.com/diffpy/diffpy.cmi/actions/workflows/matrix-and-codecov-on-merge-to-main.yml/badge.svg\n :target: https://github.com/diffpy/diffpy.cmi/actions/workflows/matrix-and-codecov-on-merge-to-main.yml\n\n.. |Codecov| image:: https://codecov.io/gh/diffpy/diffpy.cmi/branch/main/graph/badge.svg\n :target: https://codecov.io/gh/diffpy/diffpy.cmi\n\n.. |Forge| image:: https://img.shields.io/conda/vn/conda-forge/diffpy.cmi\n :target: https://anaconda.org/conda-forge/diffpy.cmi\n\n.. |PR| image:: https://img.shields.io/badge/PR-Welcome-29ab47ff\n\n.. |PyPI| image:: https://img.shields.io/pypi/v/diffpy.cmi\n :target: https://pypi.org/project/diffpy.cmi/\n\n.. |PythonVersion| image:: https://img.shields.io/pypi/pyversions/diffpy.cmi\n :target: https://pypi.org/project/diffpy.cmi/\n\n.. |Tracking| image:: https://img.shields.io/badge/issue_tracking-github-blue\n :target: https://github.com/diffpy/diffpy.cmi/issues\n\nComplex modeling infrastructure: a modulare framework for multi-modal modeling of scientific data.\n\nDiffPy.CMI is designed as an extensible complex modeling infrastructure. Users and developers can readily integrate novel data types and constraints into custom workflows. While widely used for advanced analysis of structural data, the framework is general and can be applied to any problem where model parameters are refined to fit calculated quantities to data.\n\nDiffPy.CMI is a community-driven project that supports Unix, Linux, macOS, and Windows platforms. It is designed to be used in Python scripts enabling flexible scripting and automation for advanced and reproducible workflows. Users are encouraged to leverage the software for their modeling needs and to contribute feedback, use cases, and extensions through the project community.\n\nFor more information about the diffpy.cmi library, please consult our `online documentation <https://diffpy.github.io/diffpy.cmi>`_.\n\nCitation\n--------\n\nIf you use diffpy.cmi in a scientific publication, we would like you to cite this package as\n\n Juh\u00e1s, P.; Farrow, C. L.; Yang, X.; Knox, K. R.; Billinge, S. J. L. Complex Modeling: A Strategy and Software Program for Combining Multiple Information Sources to Solve Ill Posed Structure and Nanostructure Inverse Problems. Acta Crystallogr A Found Adv 2015, 71 (6), 562\u2013568. https://doi.org/10.1107/S2053273315014473.\n\nInstallation\n------------\n\nThe preferred method is to use `Miniconda Python\n<https://docs.conda.io/projects/miniconda/en/latest/miniconda-install.html>`_\nand install from the \"conda-forge\" channel of Conda packages.\n\nTo add \"conda-forge\" to the conda channels, run the following in a terminal. ::\n\n conda config --add channels conda-forge\n\nWe want to install our packages in a suitable conda environment.\nThe following creates and activates a new environment named ``diffpy.cmi_env`` ::\n\n conda create -n diffpy.cmi_env diffpy.cmi\n conda activate diffpy.cmi_env\n\nTo confirm that the installation was successful, type ::\n\n python -c \"import diffpy.cmi; print(diffpy.cmi.__version__)\"\n\nThe output should print the latest version displayed on the badges above.\n\nIf the above does not work, you can use ``pip`` to download and install the latest release from\n`Python Package Index <https://pypi.python.org>`_.\nTo install using ``pip`` into your ``diffpy.cmi_env`` environment, type ::\n\n pip install diffpy.cmi\n\nIf you prefer to install from sources, after installing the dependencies, obtain the source archive from\n`GitHub <https://github.com/diffpy/diffpy.cmi/>`_. Once installed, ``cd`` into your ``diffpy.cmi`` directory\nand run the following ::\n\n pip install .\n\nGetting Started\n---------------\n\nYou may consult our `online documentation <https://diffpy.github.io/diffpy.cmi>`_ for tutorials and API references.\n\nSupport and Contribute\n----------------------\n\nIf you see a bug or want to request a feature, please `report it as an issue <https://github.com/diffpy/diffpy.cmi/issues>`_ and/or `submit a fix as a PR <https://github.com/diffpy/diffpy.cmi/pulls>`_.\n\nFeel free to fork the project and contribute. To install diffpy.cmi\nin a development mode, with its sources being directly used by Python\nrather than copied to a package directory, use the following in the root\ndirectory ::\n\n pip install -e .\n\nTo ensure code quality and to prevent accidental commits into the default branch, please set up the use of our pre-commit\nhooks.\n\n1. Install pre-commit in your working environment by running ``conda install pre-commit``.\n\n2. Initialize pre-commit (one time only) ``pre-commit install``.\n\nThereafter your code will be linted by black and isort and checked against flake8 before you can commit.\nIf it fails by black or isort, just rerun and it should pass (black and isort will modify the files so should\npass after they are modified). If the flake8 test fails please see the error messages and fix them manually before\ntrying to commit again.\n\nImprovements and fixes are always appreciated.\n\nBefore contributing, please read our `Code of Conduct <https://github.com/diffpy/diffpy.cmi/blob/main/CODE_OF_CONDUCT.rst>`_.\n\nContact\n-------\n\nFor more information on diffpy.cmi please visit the project `web-page <https://diffpy.github.io/>`_ or email Simon Billinge at sb2896@columbia.edu.\n\nAcknowledgements\n----------------\n\n``diffpy.cmi`` is built and maintained with `scikit-package <https://scikit-package.github.io/scikit-package/>`_.\n",
"bugtrack_url": null,
"license": null,
"summary": "Complex modeling infrastructure: a modular framework for multi-modal modeling of scientific data.",
"version": "0.0.1",
"project_urls": {
"Homepage": "https://github.com/diffpy/diffpy.cmi/",
"Issues": "https://github.com/diffpy/diffpy.cmi/issues/"
},
"split_keywords": [
"modelling",
" regression",
" diffraction",
" pdf",
" complex-modeling"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "a0d7bac41637a1d3876b4763605188d4d03503adc530e63304de79a27a40f1a1",
"md5": "8fa889e99ddf6d082817e48d6bf04769",
"sha256": "aba3b290b4e0077d595ca02b5c99ce725ae7dbbd00b5426560a4ea23e60b3755"
},
"downloads": -1,
"filename": "diffpy_cmi-0.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "8fa889e99ddf6d082817e48d6bf04769",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.14,>=3.11",
"size": 8064,
"upload_time": "2025-08-11T15:54:08",
"upload_time_iso_8601": "2025-08-11T15:54:08.450099Z",
"url": "https://files.pythonhosted.org/packages/a0/d7/bac41637a1d3876b4763605188d4d03503adc530e63304de79a27a40f1a1/diffpy_cmi-0.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "7997554774413af70c3d054c83e648cda9f841e65f6a240bc24d4ef35a59f45b",
"md5": "aee22fc55dfbe8921bb50913269319e8",
"sha256": "4ded89791626dbc4516a82bde8dec54e6d16e5b9e2d5c8dbd8d1e26b51cfb099"
},
"downloads": -1,
"filename": "diffpy_cmi-0.0.1.tar.gz",
"has_sig": false,
"md5_digest": "aee22fc55dfbe8921bb50913269319e8",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.14,>=3.11",
"size": 10785,
"upload_time": "2025-08-11T15:54:09",
"upload_time_iso_8601": "2025-08-11T15:54:09.562288Z",
"url": "https://files.pythonhosted.org/packages/79/97/554774413af70c3d054c83e648cda9f841e65f6a240bc24d4ef35a59f45b/diffpy_cmi-0.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-08-11 15:54:09",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "diffpy",
"github_project": "diffpy.cmi",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "diffpy.cmi"
}
JSON
